Skip to main content

Orchestrations

SDK methods for the Orchestrations module, accessed via soat.orchestrations. See the Orchestrations module docs for permissions and data model, and each method's REST page for the full request/response schema.

soat.orchestrations.createOrchestration()​

Create an orchestration

  • Method: POST
  • Path: /api/v1/orchestrations
await soat.orchestrations.createOrchestration({
  body: { name, nodes, edges, /* + optional */ },
});

→ Request & response schema

soat.orchestrations.listOrchestrations()​

List orchestrations

  • Method: GET
  • Path: /api/v1/orchestrations
await soat.orchestrations.listOrchestrations({
  query: { /* + optional */ },
});

→ Request & response schema

soat.orchestrations.validateOrchestration()​

Validate an orchestration graph

  • Method: POST
  • Path: /api/v1/orchestrations/validate
await soat.orchestrations.validateOrchestration({
  body: { /* + optional */ },
});

→ Request & response schema

soat.orchestrations.getQueueStats()​

Get orchestration queue stats

  • Method: GET
  • Path: /api/v1/orchestrations/queue/stats
await soat.orchestrations.getQueueStats();

→ Request & response schema

soat.orchestrations.getOrchestration()​

Get an orchestration

  • Method: GET
  • Path: /api/v1/orchestrations/{orchestration_id}
await soat.orchestrations.getOrchestration();

→ Request & response schema

soat.orchestrations.updateOrchestration()​

Update an orchestration

  • Method: PATCH
  • Path: /api/v1/orchestrations/{orchestration_id}
await soat.orchestrations.updateOrchestration({
  body: { /* + optional */ },
});

→ Request & response schema

soat.orchestrations.deleteOrchestration()​

Delete an orchestration

  • Method: DELETE
  • Path: /api/v1/orchestrations/{orchestration_id}
await soat.orchestrations.deleteOrchestration();

→ Request & response schema

soat.orchestrations.startOrchestrationRun()​

Start an orchestration run

  • Method: POST
  • Path: /api/v1/orchestration-runs
await soat.orchestrations.startOrchestrationRun({
  body: { orchestration_id, /* + optional */ },
});

→ Request & response schema

soat.orchestrations.listOrchestrationRuns()​

List orchestration runs

  • Method: GET
  • Path: /api/v1/orchestration-runs
await soat.orchestrations.listOrchestrationRuns({
  query: { /* + optional */ },
});

→ Request & response schema

soat.orchestrations.cancelOrchestrationRun()​

Cancel an orchestration run

  • Method: POST
  • Path: /api/v1/orchestration-runs/{run_id}/cancel
await soat.orchestrations.cancelOrchestrationRun();

→ Request & response schema

soat.orchestrations.submitHumanInput()​

Submit human input

  • Method: POST
  • Path: /api/v1/orchestration-runs/{run_id}/human-input
await soat.orchestrations.submitHumanInput({
  body: { node_id, /* + optional */ },
});

→ Request & response schema

soat.orchestrations.resumeOrchestrationRun()​

Resume an orchestration run

  • Method: POST
  • Path: /api/v1/orchestration-runs/{run_id}/resume
await soat.orchestrations.resumeOrchestrationRun();

→ Request & response schema

soat.orchestrations.getOrchestrationRun()​

Get an orchestration run

  • Method: GET
  • Path: /api/v1/orchestration-runs/{run_id}
await soat.orchestrations.getOrchestrationRun();

→ Request & response schema