Tools
Tools

List the agent's tools

Return the full current agent snapshot as JSON, the agent row (name, voice, model, settings), the current version's system prompt + greeting, the tool list (each tool's name, kind, description, and for HTTP tools its url/method/headers/params/mock), the `workflow` (pre-call and post-call functions), variables (name + kind; secret values are never returned, plain values are), and the `privacy` block (recording + AI consent-disclosure enabled flags + copy, PII scrub level/categories, retention, telemetry, call-recording, null on an enabled flag means it inherits the workspace default). In the in-app builder this snapshot is already inlined every turn so calling it is just a post-edit re-read; over MCP it is the ONLY way to read the prompt/tools/variables/privacy, so call it whenever you need to see current state or confirm an edit landed. Pass `version: 'published'` (or a version number) to read the live version while a draft is open. For a cheap re-read after an edit, pass `toolName` (one tool's entry) or `sections` (only the groups you need, prompt/tools/variables/voice/behaviour/privacy/settings/model/workflow) instead of pulling the whole ~50KB snapshot. In the `model` group, `judgeModel` names the grading model (null = the platform default).

GET
/workspaces/{workspace}/agents/{agent}/tools

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token from Settings > API tokens.

In: header

Path Parameters

workspace*string

Workspace slug (GET /me lists yours).

agent*string

Agent slug within the workspace.

Query Parameters

toolName?string

Return only this one tool's full entry (resolved by snake_case name) instead of the whole tool list, the cheap re-read after editing a single tool. If sections is also given, this scopes the tools section.

Length1 <= length
version?|

Read a version other than the latest: "published" for the version live calls use, or a version number. Omit for the latest version (the draft when there is one). Use it to read or copy the published prompt while a draft is open.

limit?integer

Items per page, 1 to 200. Default 50.

Range1 <= value <= 200
cursor?string

The next_cursor of the previous page.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/workspaces/string/agents/string/tools"
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "kind": "string",
      "property1": null,
      "property2": null
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "errors": [
    {
      "path": "string",
      "message": "string"
    }
  ],
  "estimate": {},
  "retryAfterSeconds": 0
}