Skip to main content

Tools

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

soat.tools.createTool()​

Create a tool

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

→ Request & response schema

soat.tools.listTools()​

List tools

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

→ Request & response schema

soat.tools.getTool()​

Get a tool

  • Method: GET
  • Path: /api/v1/tools/{tool_id}
await soat.tools.getTool({
  path: { tool_id },
});

→ Request & response schema

soat.tools.updateTool()​

Update a tool

  • Method: PATCH
  • Path: /api/v1/tools/{tool_id}
await soat.tools.updateTool({
  path: { tool_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.tools.deleteTool()​

Delete a tool

  • Method: DELETE
  • Path: /api/v1/tools/{tool_id}
await soat.tools.deleteTool({
  path: { tool_id },
});

→ Request & response schema

soat.tools.callTool()​

Call a tool

  • Method: POST
  • Path: /api/v1/tools/{tool_id}/call
await soat.tools.callTool({
  path: { tool_id },
  body: { /* + optional */ },
});

→ Request & response schema