Flows · Runs · Poll a run for status and final output
Returns one run’s current state: status, input, output,
reason_for_incompletion, and millisecond epoch timestamps (create_time,
start_time, update_time, end_time).
Terminal statuses are COMPLETED, FAILED, TERMINATED and TIMED_OUT.
RUNNING and PAUSED mean the run is still live. On success the result is in
output; on failure reason_for_incompletion says why.
expand=tasks additionally lists each task’s reference_task_name,
task_type and status — enough to identify a task waiting on approval
without pulling the full record.
This is a small payload, intended for repeated polling. Workflows take minutes to hours; polling every few seconds does not make one arrive sooner.
resource: workflow://run-control covers the polling loop and approval gates.
Authentication
Header authentication of the form Api-Key <token>
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
UUID of a single workflow execution, from flows_startWorkflow
(returned as workflow_id) or flows_listWorkflowRuns (returned as
id). NOT the small integer workflow-definition ID.
Query parameters
Set to tasks to also list each task's reference_task_name,
task_type and status — enough to identify a task waiting on
approval, without the full record.