Skip to main content
GET
Get Workflow Run Detail

Authorizations

Authorization
string
header
required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

workflow_run_id
string
required

Workflow run ID, from the response or streaming events of Run Workflow, or from message metadata in Chatflow apps.

Response

Successfully retrieved workflow run details.

id
string<uuid>

Workflow run ID.

workflow_id
string<uuid>

Workflow ID.

status
string

Workflow execution status. running for in-progress executions, succeeded when completed successfully, failed when execution encountered an error, stopped when manually halted, partial-succeeded when some nodes succeeded but others failed, paused when awaiting human input.

inputs
string | null

Input variables of the workflow run, returned as a raw JSON string that clients must parse (e.g., {"query": "..."}). May be null.

outputs
object

Output data from the workflow. An empty object until outputs are available.

error
string | null

Error message if the workflow failed.

total_steps
integer

Total number of workflow steps executed.

total_tokens
integer

Total tokens consumed.

created_at
integer<int64>

Unix timestamp of when the workflow run was created.

finished_at
integer<int64> | null

Unix timestamp of when the workflow run finished.

elapsed_time
number<float> | null

Total time elapsed in seconds.