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: { ai_provider_id, /* + 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 },
  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