v17

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-173538121.5 KB

Tools

Create Tool

Create a new tool for a bot. Tools extend bot capabilities with actions like API calls, call transfers, SMS sending, etc.

post/v1/bots/{bot_uid}/tools

Path parameters

bot_uidstring required

The unique identifier of the bot.

Request body

The type of tool that determines its behavior and required configuration.

namestring required

Tool name (max 255 characters).

descriptionstring

Description of what the tool does. This is shown to the AI to help it decide when to use the tool.

urlstring

API endpoint URL. Required for api_request type.

method'get' | 'post'

HTTP method for API requests. Defaults to get.

api_timeoutinteger

Request timeout in milliseconds.

parametersobject

JSON schema defining the tool's input parameters. The AI will extract these from the conversation.

use_raw_schemaboolean

If true, parameters is used as-is without transformation. This setting takes precedence over the type-derived default. Set to true for function type tools.

static_paramsobject

Static configuration that varies by tool type. See examples below for each type's schema.

speak_during_executionboolean

If true, bot speaks a filler message while tool executes.

speak_after_executionboolean

If true, bot announces the result after execution.

asyncboolean

If true, tool runs asynchronously without blocking the conversation.

Response

Tool created successfully.

idinteger

Unique numeric ID of the tool.