Endpoints
Get a Workflow Run
This endpoint retrieves the status and results of a workflow run using its workflow_run_id
.
GET
/
v2
/
runs
/
{workflow_run_id}
This endpoint retrieves both the current status and output data of a workflow run. The status indicates whether the workflow is still running, has completed successfully, or encountered an error.
To monitor a workflow’s progress, the recommended pattern is to:
- Call this endpoint periodically (e.g., every 3-5 seconds)
- Check the status field in the response
- Once status shows “completed”, retrieve the workflow output from the response data
Authorizations
X-Api-Key
string
headerrequiredPath Parameters
workflow_run_id
string
requiredThe ID of the workflow run to retrieve.
Response
200 - application/json
id
string
requiredversion_id
string
requiredworkflow_id
string
requiredstatus
enum<string>
requiredAvailable options:
completed
, running
, failed
, queued
, cancelled
created_at
string
requirederror
string | null
requiredresult
object | null
required