Skip to main content

Orchestrations Commands

See Orchestrations module docs for permissions and data model.

soat create-orchestration​

Create an orchestration

  • Method: POST
  • Path: /api/v1/orchestrations

Usage​

soat create-orchestration --name <string> --nodes <array<object>> --edges <array<object>>

Options​

--project-id​

Public ID of the project. Optional when authenticating with a project-scoped API key, which defaults to the key's project; required otherwise.

  • Source: body
  • Required: no
  • Type: string
--name​

Human-readable name.

  • Source: body
  • Required: yes
  • Type: string
--description​

—

  • Source: body
  • Required: no
  • Type: string \| null
--nodes​

—

  • Source: body
  • Required: yes
  • Type: array<object>
--edges​

—

  • Source: body
  • Required: yes
  • Type: array<object>
--state-schema​

—

  • Source: body
  • Required: no
  • Type: object
--input-schema​

—

  • Source: body
  • Required: no
  • Type: object

soat list-orchestrations​

List orchestrations

  • Method: GET
  • Path: /api/v1/orchestrations

Usage​

soat list-orchestrations

Options​

--project-id​

Filter by project public ID

  • Source: query
  • Required: no
  • Type: string

soat validate-orchestration​

Validate an orchestration graph

  • Method: POST
  • Path: /api/v1/orchestrations/validate

Usage​

soat validate-orchestration

Options​

--nodes​

—

  • Source: body
  • Required: no
  • Type: array<object>
--edges​

—

  • Source: body
  • Required: no
  • Type: array<object>
--input-schema​

Optional JSON Schema for run inputs; its top-level properties seed state.

  • Source: body
  • Required: no
  • Type: object

soat get-orchestration​

Get an orchestration

  • Method: GET
  • Path: /api/v1/orchestrations/{orchestration_id}

Usage​

soat get-orchestration

Options​

This command has no options.

soat update-orchestration​

Update an orchestration

  • Method: PATCH
  • Path: /api/v1/orchestrations/{orchestration_id}

Usage​

soat update-orchestration

Options​

--name​

—

  • Source: body
  • Required: no
  • Type: string
--description​

—

  • Source: body
  • Required: no
  • Type: string \| null
--nodes​

—

  • Source: body
  • Required: no
  • Type: array<object>
--edges​

—

  • Source: body
  • Required: no
  • Type: array<object>
--state-schema​

—

  • Source: body
  • Required: no
  • Type: object
--input-schema​

—

  • Source: body
  • Required: no
  • Type: object

soat delete-orchestration​

Delete an orchestration

  • Method: DELETE
  • Path: /api/v1/orchestrations/{orchestration_id}

Usage​

soat delete-orchestration

Options​

This command has no options.

soat start-orchestration-run​

Start an orchestration run

  • Method: POST
  • Path: /api/v1/orchestration-runs

Usage​

soat start-orchestration-run --orchestration-id <string>

Options​

--orchestration-id​

Orchestration to run (orch_...).

  • Source: body
  • Required: yes
  • Type: string
  • Example: orch_V1StGXR8Z5jdHi6B
--input​

Initial state for the run (merged with orchestration defaults).

  • Source: body
  • Required: no
  • Type: object
--wait​

When true, block until the run reaches a terminal (succeeded/failed) or awaiting_input state and return the settled run. When false (default), return immediately with status "running" and execute the run in the background.

  • Source: body
  • Required: no
  • Type: boolean
  • Default: false

soat list-orchestration-runs​

List orchestration runs

  • Method: GET
  • Path: /api/v1/orchestration-runs

Usage​

soat list-orchestration-runs

Options​

--orchestration-id​

Filter by orchestration public ID (orch_...)

  • Source: query
  • Required: no
  • Type: string

soat cancel-orchestration-run​

Cancel an orchestration run

  • Method: POST
  • Path: /api/v1/orchestration-runs/{run_id}/cancel

Usage​

soat cancel-orchestration-run

Options​

This command has no options.

soat submit-human-input​

Submit human input

  • Method: POST
  • Path: /api/v1/orchestration-runs/{run_id}/human-input

Usage​

soat submit-human-input --node-id <string>

Options​

--node-id​

ID of the human node to satisfy.

  • Source: body
  • Required: yes
  • Type: string
--output​

Output/response provided by the human reviewer.

  • Source: body
  • Required: no
  • Type: object

soat resume-orchestration-run​

Resume an orchestration run

  • Method: POST
  • Path: /api/v1/orchestration-runs/{run_id}/resume

Usage​

soat resume-orchestration-run

Options​

This command has no options.

soat get-orchestration-run​

Get an orchestration run

  • Method: GET
  • Path: /api/v1/orchestration-runs/{run_id}

Usage​

soat get-orchestration-run

Options​

This command has no options.