Runs

Answer a paused run

POST
/api/v1/orchestrations/runs/{run_id}/resume

Submit a person's answer and continue a paused run, waiting for its result — or its next question. The answer is written to the Human step's output key and to human_response. The response has the same shapes as run: completed, paused at another gate, or failed — or cancelled, for a run cancelled while resuming. A run that a scale-mode worker is running answers {"status": "resuming", "run_id": "…"} at once; read it back for the rest. See the Orchestrations API.

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 paused run.

application/json
  1. body

The answer to the question a paused run is asking.

response?|

Required: text, or an object keyed by the question's field names. A Human step with no fields holds a plain answer as its text, so "yes" and {"response": "yes"} store the same thing. An answer that says nothing — blank text, or {} — is a 422. A tool confirmation takes {"approve": true}, or false to refuse.

question_id?|null

Response Body

The run's result, or its next question.

application/json
  1. response
status?string
run_id?string
response?string
shared_state?
step_history?array<string>
curl -X POST "https://api.synapseorch.com/api/v1/orchestrations/runs/run_01a10a1553d57036bae3d17421a4ba16/resume" \  -H "Authorization: Bearer sk-syn-..." \  -H "Content-Type: application/json" \  -d '{    "response": {      "decision": "approve",      "comments": "Looks great, publish it."    }  }'
{  "status": "completed",  "run_id": "run_orch_k3j9x2a_1734567890123_4f2a9c",  "response": "# SynapseOrch platform\n\nSynapseOrch is…",  "shared_state": {    "decision": "approve",    "...": "..."  },  "step_history": [    "..."  ]}