API ReferencePlatform API

Api Workflow Runs Retrieve

WorkflowRun resource (retrieve, update, delete).

GET /api/workflow-runs/{run_id}/ — retrieve run details PATCH /api/workflow-runs/{run_id}/ — resume or cancel a paused run DELETE /api/workflow-runs/{run_id}/ — delete run

Authentication

AuthorizationBearer
JWT access token or Respan API key

Path parameters

run_idstringRequired

Response

idstringRead-only
workflow_typestringRead-only
statusenum
  • pending - Pending
  • running - Running
  • paused - Paused
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
  • timeout - Timeout
current_step_indexintegerRead-only
step_resultsanyRead-only
error_messagestring or nullRead-only
paused_atdatetime or nullRead-only
trace_idstringRead-only
created_atdatetimeRead-only
updated_atdatetimeRead-only