Skip to main content
GET
Runs lifecycle

Why run_id (not task_id)?

apisale’s core object is a Run — one inference job for a model slug. The public JSON field is run_id (snake_case). We use run consistently in URLs (/v1/run/..., /v1/runs/...), Console, and webhooks.

1. Submit

string
required
Unique run identifier, e.g. run_0192a1b2-.... Save this to poll or correlate webhooks.
string
required
Initial status: queued (async) or processing / succeeded (sync).
object
null until status is succeeded. On sync runs, may contain the final payload immediately.

Example (async submit)

2. Poll status

Poll every 2–5 seconds until terminal state, or use webhooks.

3. Success output

When status is succeeded, output shape depends on the model (see each model page Output schema). Common patterns:

4. Optional webhook

Pass webhook_url on submit to receive the same Run JSON when the run reaches a terminal state.