Skip to main content
GET
Get one run by id

Authorizations

X-API-Key
string
header
required

Batch, Crawl, the Extract endpoints and the account endpoint read the same key from the X-API-Key header.

Path Parameters

job_id
string
required

Assigned by the server on submit.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
run_id
string
required

Assigned by the server when a run is created (submit or rerun).

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

OK

run_id
string
required
job_id
string
required
run_sequence
integer
required
Required range: x >= 1
status
enum<string>
required

In-flight:

  • running: work queued / in flight.
  • pending: initial run of an open job, idle between batches.

Terminal:

  • completed: natural finish.
  • stopped: caller called POST /jobs/{id}/stop. No new tasks are picked up; in-flight tasks may still finish. Result bodies are kept. stats.completed < stats.total signals "stopped early".
  • failed: the run was auto-failed on an account-level error (insufficient credits / inactive subscription / the API key's credit cap reached). No new tasks are picked up; failure_reason and failure_detail carry the cause. Re-runnable once the account or cap is resolved. Result bodies already produced are kept.
  • deleted: caller called DELETE /v1/jobs/{id}/runs/{run_id}. The run's result bodies and data are being deleted; once complete the run disappears.

Clients must accept values not listed here.

Available options:
running,
pending,
completed,
stopped,
failed,
deleted
stats
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
trigger
enum<string>

What set this run in motion. Always set.

  • manual: caller-initiated: POST /jobs, POST /jobs/{id}/rerun (any job type, full or ?status=-filtered, manual fire of a scheduled job).
  • scheduled: automatic, fired by the configured schedule (recurring or one-shot).

Clients must accept values not listed here.

Available options:
manual,
scheduled
last_batch_received
boolean

Meaningful only for the initial run of an open job. Once true, addBatchTasks is rejected and the run drains into completed.

pause_state
enum<string>

Reversible-suspend flag, orthogonal to status. A run never paused omits it; a resumed run returns active explicitly. Treat a missing field as active. Flip via POST /jobs/{id}/pause and /resume.

Available options:
active,
paused
ingest_status
enum<string>

Present only on runs created by a large (202) submission or a large (202) rerun. pending: task rows are still streaming into storage; reads may return partial pages and addBatchTasks returns 409. done: every accepted task row is visible. Omitted on runs whose tasks were written on the request path (201 submissions and reruns, addBatchTasks batches).

Clients must accept values not listed here.

Available options:
pending,
done
failure_reason
enum<string>

Present only when status == failed: the account-level cause of the auto-fail. Omitted otherwise. Distinct from stats.failure_reasons (the per-task rollup).

  • insufficient_credits: the account is out of credits, or the plan doesn't include a feature the task needs.
  • subscription_inactive: the subscription is not active or has expired, the plan doesn't include the API, or the job's API key is no longer valid.
  • api_key_cap_reached: the job's API key reached one of its credit caps (day, week, month or billing period). Resolves on its own when that cap's window resets, or when the cap is raised.

Clients must accept values not listed here.

Available options:
insufficient_credits,
subscription_inactive,
api_key_cap_reached
failure_detail
string

Human-readable explanation of failure_reason, e.g. which cap was reached and when it resets. Present only when failure_reason is. At most 500 characters (Unicode code points); longer upstream text is cut. Free text for display: branch on failure_reason, never on this string.

Example:

"Subscription has no credit available."