Skip to main content
GET
Get Run

Behavior

  • Poll this endpoint with the id returned by Create Run until status reaches a terminal value (COMPLETED, FAILED, CANCELLED, or SKIPPED).
  • report is the full analyst-facing result as Markdown text. It is only set once status is COMPLETED.
  • output_ref is set once structured output has been captured for the run. Its presence (not its value) is the signal that Get Run Output URL can be called to download the structured output file.
  • error is only set when status is FAILED.
  • Returns 404 if runId does not exist, or belongs to a different customer.

Authorizations

X-API-KEY
string
header
required

Path Parameters

runId
string
required

The run's id, returned by POST /flows/{flowId}/runs

Response

OK

id
string<uuid>
required
flow_id
string
required
status
enum<string>
required

QUEUED: awaiting worker pickup. RUNNING: executing. COMPLETED/FAILED/CANCELLED/SKIPPED: terminal states.

Available options:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
CANCELLED,
SKIPPED
triggered_at
string<date-time>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
started_at
string<date-time> | null

Set once the run moves from QUEUED to RUNNING.

completed_at
string<date-time> | null

Set once the run reaches a terminal state.

input
object

The input the run was triggered with.

report
string | null

The full analyst-facing Markdown report. Set only once the run has COMPLETED.

output_ref
string | null

Present once structured output has been captured. Its presence means GET /flow-runs/{runId}/output-url can be called to download it.

error
object | null

Set only when status is FAILED.