Skip to main content
POST
/
agent
/
tool
/
{agent_id}
Create/Update Tool
curl --request POST \
  --url https://api.getoutbox.ai/agent/tool/{agent_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "id": "<string>",
  "description": "<string>",
  "url": "<string>",
  "method": "POST",
  "type": "custom",
  "mcp_tool": "<string>",
  "auth_token": "<string>",
  "is_async": false,
  "is_success": false,
  "messages": [
    {
      "type": "request",
      "content": "<string>"
    }
  ],
  "schema": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "type": "<string>",
      "required": true
    }
  ]
}
'

Authorizations

Authorization
string
header
required

Company API Key

Path Parameters

agent_id
string
required

The ID of the agent

Body

application/json

Tool configuration

name
string
required

Tool name

id
string

Tool ID (for updating existing tool)

description
string

Tool description

url
string

API endpoint URL

method
string
default:POST

HTTP method

type
string
default:custom

Tool type

mcp_tool
string

MCP tool identifier

auth_token
string

Authentication token

is_async
boolean
default:false

Async execution flag

is_success
boolean
default:false

Success status flag

messages
object[]
schema
object[]

Response

Tool created/updated successfully