Runs

Get a run's status

GET
/api/v2/orchestrations/runs/{run_id}/status

A run's state. status is queued, running, paused, completed, failed or cancelled. On SynapseOrch Cloud, a paused run also carries the question it is asking, human_input_required, and a run that has ended carries what it made: response (the orchestration's Result key), shared_state, and error when it did not complete. Poll every few seconds; a run has nothing new to say until its next step ends.

A self-hosted install answers the state alone — no human_input_required, response, shared_state or error; read those with /api/v1 — and adds worker_id.

apiKey
headerAuthorizationBearer <token>

An API key, sk-syn- and 32 characters. On SynapseOrch Cloud an owner or admin makes it under Settings → Developer; on a self-hosted install, under Settings → API Keys.

run_id*string

The run, from the start's answer.

Response Body

The run.

application/json
  1. response
run_id?string
orchestration_id?string
status?string
current_step_id?unknown
waiting_for_human?boolean
total_cost_usd?number
total_tokens_used?integer
started_at?string
ended_at?string
response?string
shared_state?
error?unknown
curl -X GET "https://api.synapseorch.com/api/v2/orchestrations/runs/run_01a10a1553d57036bae3d17421a4ba16/status" \  -H "Authorization: Bearer sk-syn-..."

{  "run_id": "run_01a10a1553d57036bae3d17421a4ba16",  "orchestration_id": "orch_01a10a0f2d4b6c8e0a1b3c5d7e9f1a2b",  "status": "completed",  "current_step_id": null,  "waiting_for_human": false,  "total_cost_usd": 0.0002,  "total_tokens_used": 4133,  "started_at": "2026-10-04T17:52:12Z",  "ended_at": "2026-10-04T17:52:17Z",  "response": "Yes. Under the FTC's Mail Order Rule we ship within 30 days when no other time is stated [K1]…",  "shared_state": {    "user_input": "Do you ship within 30 days?",    "answer": "…"  },  "error": null}