Skip to main content
get/workflows/run/{workflow_run_id}
Request example
Response
get/workflows/run/{workflow_run_id}

Authorization

Authorizationstringheaderrequired#

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_idstringrequired#
Workflow run ID, from the response or streaming events of Run Workflow, or from message metadata in Chatflow apps.

Responses

application/json
Successfully retrieved workflow run details.
created_atinteger#
Unix timestamp of when the workflow run was created.
elapsed_timenumber#
Total time elapsed in seconds.
errorstring#
Error message if the workflow failed.
finished_atinteger#
Unix timestamp of when the workflow run finished.
idstring#
Workflow run ID.
inputsstring#
Input variables of the workflow run, returned as a raw JSON string that clients must parse (e.g., {"query": "..."}). May be null.
outputsobject#
Output data from the workflow. An empty object until outputs are available.
statusstring#
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.
total_stepsinteger#
Total number of workflow steps executed.
total_tokensinteger#
Total tokens consumed.
workflow_idstring#
Workflow ID.