AI workflow guides Your workspace
Find your way forward

API reference in Superagento

Learn to build AI agents, connect tools and
understand every workflow run.

Reference/API reference1 min read

API reference

The endpoints the product itself is built on. Session cookies authenticate every call.

MethodPathPurpose
GET/api/v1/healthLiveness and version
GET/api/v1/workflowsWorkflows owned by the caller
POST/api/v1/workflowsCreate one — 409 at the plan's cap
GET/api/v1/workflows/{id}One workflow, including its graph
POST/api/v1/workflows/{id}/test-runsExecute now and return the step log
POST/api/v1/workflows/{id}/runsRun a published workflow
GET/api/v1/workflows/{id}/costWorst-case credit cost, before running
GET/api/v1/executionsRun history
GET/api/v1/usagePlan, allowance and standing
GET/api/v1/usage/ledgerEvery charge, newest first
GET/api/v1/ai/providersProvider catalog
bash
curl "$NUDGE_API/api/v1/usage" -b cookies.txt
# {
#   "plan": { "id": "free", "monthly_runs": 100, "max_workflows": 2 },
#   "credits_remaining": 1760.0,
#   "runs_used": 15,
#   "exhausted": false
# }
A little help goes a long way.Your run history is a good place to find what happened at every step.
Take a closer look