Get an orchestration

GET

/api/v2/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, 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

steps?array<>

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

{  "id": "orch_01a10a0f2d4b6c8e0a1b3c5d7e9f1a2b",  "name": "Answer a customer question",  "description": "Search the policy base and answer a stockist's question with citations.",  "entry_step_id": "find",  "steps": [    {      "id": "find",      "name": "Find the policy",      "type": "retrieve",      "output_key": "sources",      "next_step_id": "answer",      "...": "..."    }  ],  "...": "..."}