Answer a paused run
Answer the question a paused run is asking, and the run carries on from the next step. The answer is 202 with "status": "resuming"; follow the run as before. It answers a pause only — a failed run is never replayed. A run that is not waiting for an answer, or a second answer arriving at the same moment, is a 409. The question is on the run's page in the app too, and whichever answer arrives first resumes the run. See the public API guide.
apiKeyAuthorizationBearer <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 paused run.
application/json- body
The answer to the question a paused run is asking, and where to be called back.
response?|Required: text, or an object keyed by the question's field names. An answer that says nothing — blank text, or {} — is a 422. A tool confirmation takes {"approve": true}, or false to refuse.
webhook_url?|A URL to call when the run ends; it replaces any the run was waiting to deliver. On SynapseOrch Cloud it must be a public https address.
webhook_secret?|Signs the call, so your server can check it came from SynapseOrch.
question_id?|nullThe answer was accepted and the run is resuming.
application/json- response
run_id?stringstatus?stringstream_url?stringcurl -X POST "https://api.synapseorch.com/api/v2/orchestrations/runs/run_01a10a1553d57036bae3d17421a4ba16/resume" \ -H "Authorization: Bearer sk-syn-..." \ -H "Content-Type: application/json" \ -d '{ "response": { "approved": true, "comment": "Onboarding signed off; pay net-15." } }'{ "run_id": "run_01a10843ee6d704bbccfb11933a861d1", "status": "resuming", "stream_url": "/api/v2/orchestrations/runs/run_01a10843ee6d704bbccfb11933a861d1/stream"}