Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
platformApi

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

get/api/workflow-runs/{run_id}/

Path parameters

run_idstring required

Headers

Authorizationstring required

JWT access token or Respan API key

Response

idstring required
workflow_typestring required
status'pending' | 'running' | 'paused' | 'completed' | 'failed' | 'cancelled' | 'timeout' required
  • pending - Pending
  • running - Running
  • paused - Paused
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
  • timeout - Timeout
current_step_indexinteger required
{"stackTrail":"components:schemas:WorkflowRunRead:properties:step_results","oasType":"schema","type":"unknown","description":"Any type"}
error_messagestring nullable required
paused_atstring date-time nullable required
trace_idstring required
created_atstring date-time required
updated_atstring date-time required