Skip to main content
POST
Execute Orchestration
Creates a tracking record for a multi-agent orchestration. Supply pattern, orchestrator_id, and agent_ids, with optional input_payload and metadata. The current handler records an execution and returns HTTP 201. It does not itself execute your agents or guarantee that work has completed. An execution record or initial status is not evidence of completed tool calls. The generated orchestration receipt uses a system marker, not a cryptographic signature. Use the generated parameter fields above for the request contract. Authenticate with a credential for the target workspace and environment; do not supply a tenant-selection header.

Authorizations

X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
agent_ids
string[]
required
orchestrator_id
string
required
pattern
string
required
input_payload
any
metadata
any

Response

Orchestration started

orchestration_id
string<uuid>
workflow_id
string<uuid>
agents
string<uuid>[]
parameters
object
status
enum<string>
Available options:
pending,
running,
completed,
failed,
cancelled
steps
object[]
results
object
receipts
string<uuid>[]
created_at
string<date-time>