JSON:API · v1

Runs and monitoring

Follow workflow runs and inspect their per-step outcomes.

Bearer authentication api_read / api_write by operation Stable

Operations


                  /api/json/v1/workflow_runs


                  /api/json/v1/workflow_runs/{id}


                  /api/json/v1/workflow_runs/{workflow_run_id}/steps

These are the reviewed public attributes. Fields omitted from this contract are not part of the API, even when they exist internally.

Workflow run type: workflow_run 11 fields

Public JSON:API resource object for workflow runs.

Field	Type	Presence	Description
completed_at	object \| null	Optional · nullable	Timestamp when processing reached a terminal state.
error_message	string \| null	Optional · nullable	Safe failure summary when processing did not complete.
event_id	string	Required	The Event record (public schema) whose payload triggered this run. Field included by default.
generation	integer	Required	The executor token for this run. A transition or journal write carrying an older generation has been fenced by a reclaim. Field included by default.
parent_run_id	string \| null	Optional · nullable	Parent run id returned by the public contract.
parent_step_identifier	string \| null	Optional · nullable	The subflow step of `parent_run` that is waiting for this run. Set together with parent_run_id, and only on a child run. Field included by default.
snapshot_id	string	Required	Snapshot id returned by the public contract.
started_at	object \| null	Optional · nullable	Timestamp when processing started.
state	enum: pending \| running \| completed \| suspended \| failed	Required	Current lifecycle or execution state.
suspend_reason	enum: delay \| yield \| rate \| manual \| waiting_child \| null	Optional · nullable	Why the run released its slot to wait. Cleared when it resumes. Field included by default.
workflow_id	string	Required	Workflow that owns or produced the resource.