Skip to main content

Agents

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

soat.agents.createAgent()​

Create an agent

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

→ Request & response schema

soat.agents.listAgents()​

List agents

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

→ Request & response schema

soat.agents.getAgent()​

Get an agent

  • Method: GET
  • Path: /api/v1/agents/{agent_id}
await soat.agents.getAgent({
  path: { agent_id },
});

→ Request & response schema

soat.agents.updateAgent()​

Update an agent

  • Method: PUT
  • Path: /api/v1/agents/{agent_id}
await soat.agents.updateAgent({
  path: { agent_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.agents.patchAgent()​

Partially update an agent

  • Method: PATCH
  • Path: /api/v1/agents/{agent_id}
await soat.agents.patchAgent({
  path: { agent_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.agents.deleteAgent()​

Delete an agent

  • Method: DELETE
  • Path: /api/v1/agents/{agent_id}
await soat.agents.deleteAgent({
  path: { agent_id },
  query: { /* + optional */ },
});

→ Request & response schema

soat.agents.createAgentGeneration()​

Run an agent generation

  • Method: POST
  • Path: /api/v1/agents/{agent_id}/generate
await soat.agents.createAgentGeneration({
  path: { agent_id },
  query: { /* + optional */ },
  body: { messages, /* + optional */ },
});

→ Request & response schema

soat.agents.submitAgentToolOutputs()​

Submit tool outputs for a paused generation

  • Method: POST
  • Path: /api/v1/agents/{agent_id}/generate/{generation_id}/tool-outputs
await soat.agents.submitAgentToolOutputs({
  path: { agent_id, generation_id },
  body: { tool_outputs },
});

→ Request & response schema

soat.agents.listAgentVersions()​

List an agent's config versions

  • Method: GET
  • Path: /api/v1/agents/{agent_id}/versions
await soat.agents.listAgentVersions({
  path: { agent_id },
  query: { /* + optional */ },
});

→ Request & response schema

soat.agents.getAgentVersion()​

Get an archived agent config version

  • Method: GET
  • Path: /api/v1/agents/{agent_id}/versions/{version}
await soat.agents.getAgentVersion({
  path: { agent_id, version },
});

→ Request & response schema

soat.agents.restoreAgentVersion()​

Restore an archived config as a new version

  • Method: POST
  • Path: /api/v1/agents/{agent_id}/versions/{version}/restore
await soat.agents.restoreAgentVersion({
  path: { agent_id, version },
  body: { /* + optional */ },
});

→ Request & response schema

soat.agents.setAgentRelease()​

Set or replace a staged rollout

  • Method: PUT
  • Path: /api/v1/agents/{agent_id}/release
await soat.agents.setAgentRelease({
  path: { agent_id },
  body: { stable_version, canary_version, canary_percent, /* + optional */ },
});

→ Request & response schema

soat.agents.promoteAgentRelease()​

Promote the canary and end the rollout

  • Method: POST
  • Path: /api/v1/agents/{agent_id}/release/promote
await soat.agents.promoteAgentRelease({
  path: { agent_id },
});

→ Request & response schema

soat.agents.abortAgentRelease()​

Abort the rollout and roll back to stable

  • Method: POST
  • Path: /api/v1/agents/{agent_id}/release/abort
await soat.agents.abortAgentRelease({
  path: { agent_id },
});

→ Request & response schema