Runs
Get a run
GET
A run's state, and its result once it has ended — the way back for a caller whose stream dropped: the run carried on, and this returns what the stream would have ended with. A run that has ended carries response, shared_state and step_history; a paused one carries human_input_required, also for a question asked inside a nested orchestration; a running one carries shared_state and step_history so far. A run that did not complete also carries error, saying why. Poll it rather than holding a connection. See the Orchestrations API.
apiKeyheader
AuthorizationBearer <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*stringThe run.
The run.
application/json- response
status?stringrun_id?stringresponse?stringshared_state?step_history?array<string>curl -X GET "https://api.synapseorch.com/api/v1/orchestrations/runs/run_01a10a1553d57036bae3d17421a4ba16" \ -H "Authorization: Bearer sk-syn-..."{ "status": "completed", "run_id": "run_orch_k3j9x2a_1734567890123_4f2a9c", "response": "# SynapseOrch platform\n\nSynapseOrch is…", "shared_state": { "user_input": "SynapseOrch platform", "research": "...", "article": "..." }, "step_history": [ "..." ]}{ "status": "paused", "run_id": "run_orch_k3j9x2a_1734567890123_4f2a9c", "human_input_required": { "step_id": "step_approve", "prompt": "Review the draft and approve or reject it.", "fields": [ { "name": "decision", "type": "string", "label": "Decision" } ] }}{ "status": "queued", "run_id": "run_01a10a1553d57036bae3d17421a4ba16", "queue_position": 2}