Create custom tool

Path Parameters

ai_agent_id

string

required

Body

application/json

additional_tool_info

object

required

API configuration and other custom tool specific details needed for implementation

additional_tool_info.api

object

required

Complete API configuration including endpoint, method, headers, and parameters

additional_tool_info.api.endpoint

string

required

The complete URL endpoint where the API requests will be sent (e.g., https://api.example.com/v1/resource)

additional_tool_info.api.headers

object

required

HTTP headers required for the API request, such as authentication tokens or content type specifications

additional_tool_info.api.headers.{key}

string

additional_tool_info.api.method

string

required

The HTTP method to be used for the API request (e.g., GET, POST, PUT, DELETE)

additional_tool_info.api.parameters

object

required

Configuration for both fixed and runtime parameters that will be used in API requests

additional_tool_info.api.parameters.fixed_params

object | null

Dictionary of parameters that remain constant across all API calls. Each parameter has a description and fixed value

additional_tool_info.api.parameters.fixed_params.{key}

object

additional_tool_info.api.parameters.runtime_params

object | null

Dictionary of parameters that must be provided at runtime. Each parameter has a description explaining its purpose

additional_tool_info.api.parameters.runtime_params.{key}

object

additional_tool_info.tool_type

enum<string>

default:

custom

Identifier specifying this is a custom tool implementation. Will always be set to 'custom'

Available options:

custom

openai_tool

object

required

OpenAI function definition specifying the tool's interface for AI interaction

openai_tool.description

string

required

openai_tool.name

string

required

openai_tool.parameters

object

required

openai_tool.parameters.properties

object

required

openai_tool.parameters.properties.{key}

object

openai_tool.parameters.properties.{key}.type

required

Available options:

string,

number,

integer,

boolean,

object,

array,

null

openai_tool.parameters.properties.{key}.additionalProperties

openai_tool.parameters.properties.{key}.default

any | null

openai_tool.parameters.properties.{key}.description

string | null

openai_tool.parameters.properties.{key}.enum

any[] | null

openai_tool.parameters.properties.{key}.format

string | null

openai_tool.parameters.properties.{key}.items

object | null

openai_tool.parameters.properties.{key}.maximum

number | null

openai_tool.parameters.properties.{key}.minimum

number | null

openai_tool.parameters.properties.{key}.properties

object | null

openai_tool.parameters.properties.{key}.required

string[] | null

openai_tool.parameters.additionalProperties

boolean | null

default:

false

openai_tool.parameters.required

string[] | null

openai_tool.parameters.type

enum<string>

default:

object

Available options:

object

Response

201 - application/json

additional_tool_info

object

required

Complete configuration for the custom tool including API details

additional_tool_info.api

object

required

Complete API configuration including endpoint, method, headers, and parameters

additional_tool_info.api.endpoint

string

required

The complete URL endpoint where the API requests will be sent (e.g., https://api.example.com/v1/resource)

additional_tool_info.api.headers

object

required

HTTP headers required for the API request, such as authentication tokens or content type specifications

additional_tool_info.api.headers.{key}

string

additional_tool_info.api.method

string

required

The HTTP method to be used for the API request (e.g., GET, POST, PUT, DELETE)

additional_tool_info.api.parameters

object

required

Configuration for both fixed and runtime parameters that will be used in API requests

additional_tool_info.api.parameters.fixed_params

object | null

Dictionary of parameters that remain constant across all API calls. Each parameter has a description and fixed value

additional_tool_info.api.parameters.fixed_params.{key}

object

additional_tool_info.api.parameters.runtime_params

object | null

Dictionary of parameters that must be provided at runtime. Each parameter has a description explaining its purpose

additional_tool_info.api.parameters.runtime_params.{key}

object

additional_tool_info.tool_type

enum<string>

default:

custom

Identifier specifying this is a custom tool implementation. Will always be set to 'custom'

Available options:

custom

created_at

string

required

Timestamp indicating when this custom tool was created

openai_tool

object

required

OpenAI function definition containing the tool's interface specification

openai_tool.description

string

required

openai_tool.name

string

required

openai_tool.parameters

object

required

openai_tool.parameters.properties

object

required

openai_tool.parameters.properties.{key}

object

openai_tool.parameters.properties.{key}.type

required

Available options:

string,

number,

integer,

boolean,

object,

array,

null

openai_tool.parameters.properties.{key}.additionalProperties

openai_tool.parameters.properties.{key}.default

any | null

openai_tool.parameters.properties.{key}.description

string | null

openai_tool.parameters.properties.{key}.enum

any[] | null

openai_tool.parameters.properties.{key}.format

string | null

openai_tool.parameters.properties.{key}.items

object | null

openai_tool.parameters.properties.{key}.maximum

number | null

openai_tool.parameters.properties.{key}.minimum

number | null

openai_tool.parameters.properties.{key}.properties

object | null

openai_tool.parameters.properties.{key}.required

string[] | null

openai_tool.parameters.additionalProperties

boolean | null

default:

false

openai_tool.parameters.required

string[] | null

openai_tool.parameters.type

enum<string>

default:

object

Available options:

object

updated_at

string

required

Timestamp indicating when this custom tool was last modified

tool_id

string

Unique identifier for the custom tool

API Documentation

AI Agents v2

Built-in Tools

Custom Tools

Calls

Post-call Analysis

Phone Numbers

Knowledge Bases

Public Sharing

API Keys

Path Parameters

Body

Response