tools

Add Tool To Agent

Add and configure a tool for a specific agent.

Multi-Level Configuration:

Tenant Level: API keys, OAuth tokens (shared across all agents)
Agent Level: Tool-specific settings (different per agent)

How It Works:

Tool connection created at tenant level (if needed)
Agent-specific configuration stored separately
Different agents can use same tool with different configs

Example: Google Sheets Tool

{
  "tool_key": "google_sheets_tool",
  "enabled": true,
  "config": {
    "access_token": "ya29.xxx",        // Tenant level (shared)
    "refresh_token": "1//xxx",         // Tenant level (shared)
    "spreadsheetId": "1BxiMVxxx",     // Agent level (unique per agent)
    "range": "Sheet1!A:Z"              // Agent level (unique per agent)
  }
}

Example: Slack Tool

{
  "tool_key": "slack_send_message_tool",
  "enabled": true,
  "config": {
    "bot_token": "xoxb-xxx",           // Tenant level (shared)
    "channel": "#agent1-notifications" // Agent level (unique per agent)
  }
}

Result:

Agent 1 can log to “Sheet1” with “#support” channel
Agent 2 can log to “Sheet2” with “#sales” channel
Both use same tenant OAuth token

POST

tools

agents

{agent_id}

add-tool

Add Tool To Agent

curl --request POST \
  --url https://api.example.com/tools/agents/{agent_id}/add-tool \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id

string<uuid>

required

Body

application/json

The body is of type Tool Config · object.

Response

Successful Response

Create Custom ToolCreate or update custom tool with upsert logic.

Add Tool To Agent

curl --request POST \
  --url https://api.example.com/tools/agents/{agent_id}/add-tool \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Documentation Index

Authorizations

Path Parameters

Body

Response