Get an orchestration

GET

/api/v1/orchestrations/{orch_id}

One orchestration's definition: its steps and how they connect, the entry step, the state schema and the guardrails. Every step carries all of its fields, including those left at their defaults, so a step is much longer than shown here; see Step Types.

Authorization

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.

Path Parameters

orch_id*string

The orchestration's id.

Response Body

The orchestration.

application/json

response

id?string

name?string

description?string

entry_step_id?string

state_schema?

steps?array<>

max_total_turns?integer

timeout_minutes?integer

curl -X GET "https://api.synapseorch.com/api/v1/orchestrations/orch_01a10a0f2d4b6c8e0a1b3c5d7e9f1a2b" \  -H "Authorization: Bearer sk-syn-..."

{  "id": "orch_k3j9x2a",  "name": "Research → Report",  "description": "Research a topic and generate a report",  "entry_step_id": "step_research",  "state_schema": {    "research": {      "type": "str",      "default": "",      "description": "Research notes"    }  },  "steps": [    {      "id": "step_research",      "name": "Research",      "type": "agent",      "agent_id": "agent_1726412345678",      "prompt_template": "Research {state.user_input}",      "output_key": "research",      "next_step_id": "step_write",      "...": "..."    }  ],  "max_total_turns": 100,  "timeout_minutes": 30,  "...": "..."}