Skip to main content
POST
Attach Tool

Authorizations

X-API-Key
string
header
required

Workspace API key (e.g. kej_live_...)

Path Parameters

agent_id
string
required

Body

application/json

Attach a tool to an agent.

tool_name
string
required

Tool name — custom tool name or builtin name

tool_id
string | null

Tool ID — required for custom HTTP tools

channels
string[]

Channels where the tool is active: 'voice:in-call', 'voice:post-call', 'whatsapp'

config
Config · object

Tool-specific configuration. The shape depends on the tool — see the Tools guide for the full schema of each builtin.

Examples for selected builtins:

agent_transfer — transfer the live call to a different persona:

create_call — create a new outbound call from inside a conversation:

Response

Successful Response

A tool attached to an agent.

tool_name
string
required
channels
string[]
required
config
Config · object
required
tool_id
string | null