Skip to main content
GET
Get a run
Requires the runs:read scope. See polling a run for what each status means and when to stop polling.

Authorizations

X-Api-Key
string
header
required

Path Parameters

runId
string<uuid>
required

Response

OK

id
string<uuid>
required
Example:

"0199a6c2-4b7d-7e01-8f3a-2c4d6e8f0a1b"

workflowId
string<uuid>
required
Example:

"0199a6c1-9e2f-7c3d-8a4b-1c2d3e4f5a6b"

documentId
string<uuid>
required
Example:

"0199a6c2-3f1e-7b2a-9c4d-5e6f7a8b9c0d"

kind
enum<string>
required
Available options:
full,
step_test,
up_to_node_test,
restart_from_node,
fan_out_child,
sub_workflow_call
Example:

"full"

status
enum<string>
required
Available options:
running,
completed,
failed,
cancelled,
awaiting_children,
queued,
review,
waiting
Example:

"completed"

startedOn
string<date-time>
required
Example:

"2026-10-02T14:03:11+00:00"

billedCredits
integer<int32>
required
Example:

3

parentRunId
null | string<uuid>
sourceRunId
null | string<uuid>
error
null | object
reference
null | string
Example:

"PO-1182"

completedOn
null | string<date-time>