Create custom tool

POST

ai-agents

{ai_agent_id}

custom-tools

{
  "tool_id": "<string>",
  "tool_start_message": "<string>",
  "tool_delayed_message": "<string>",
  "tool_complete_message": "<string>",
  "tool_failed_message": "<string>",
  "openai_tool": {
    "description": "Get the delivery date for a customer's order",
    "name": "get_delivery_date",
    "parameters": {
      "additionalProperties": false,
      "properties": {
        "order_id": {
          "description": "The customer's order ID",
          "type": "string"
        }
      },
      "required": [
        "order_id"
      ],
      "type": "object"
    }
  },
  "additional_tool_info": {
    "tool_type": "custom",
    "api": {
      "endpoint": "https://api.example.com/test",
      "headers": {
        "Content-Type": "application/json"
      },
      "method": "POST",
      "parameters": {
        "fixed_params": {
          "api_key": {
            "description": "API key for authentication",
            "value": "test-api-key"
          }
        },
        "runtime_params": {}
      }
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Path Parameters

ai_agent_id

string

required

Body

application/json

openai_tool

object

required

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

Example:

{
  "description": "Get the delivery date for a customer's order",
  "name": "get_delivery_date",
  "parameters": {
    "additionalProperties": false,
    "properties": {
      "order_id": {
        "description": "The customer's order ID",
        "type": "string"
      }
    },
    "required": ["order_id"],
    "type": "object"
  }
}

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

Example:

{
  "endpoint": "https://api.example.com/test",
  "headers": { "Content-Type": "application/json" },
  "method": "POST",
  "parameters": {
    "fixed_params": {
      "api_key": {
        "description": "API key for authentication",
        "value": "test-api-key"
      }
    },
    "runtime_params": {}
  }
}

additional_tool_info.tool_type

string

default:custom

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

Allowed value: "custom"

tool_id

string

tool_start_message

string | null

Optional message to display when the tool is started

tool_delayed_message

string | null

Optional message to display when the tool is delayed

tool_complete_message

string | null

Optional message to display when the tool is completed

tool_failed_message

string | null

Optional message to display when the tool fails

Response

201

application/json

Successful Response

openai_tool

object

required

OpenAI function definition containing the tool's interface specification

Example:

{
  "description": "Get the delivery date for a customer's order",
  "name": "get_delivery_date",
  "parameters": {
    "additionalProperties": false,
    "properties": {
      "order_id": {
        "description": "The customer's order ID",
        "type": "string"
      }
    },
    "required": ["order_id"],
    "type": "object"
  }
}

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

Example:

{
  "endpoint": "https://api.example.com/test",
  "headers": { "Content-Type": "application/json" },
  "method": "POST",
  "parameters": {
    "fixed_params": {
      "api_key": {
        "description": "API key for authentication",
        "value": "test-api-key"
      }
    },
    "runtime_params": {}
  }
}

additional_tool_info.tool_type

string

default:custom

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

Allowed value: "custom"

created_at

string

required

Timestamp indicating when this custom tool was created

updated_at

string

required

Timestamp indicating when this custom tool was last modified

tool_id

string

Unique identifier for the custom tool

tool_start_message

string | null

Optional message to display when the tool is started

tool_delayed_message

string | null

Optional message to display when the tool is delayed

tool_complete_message

string | null

Optional message to display when the tool is completed

tool_failed_message

string | null

Optional message to display when the tool fails

List custom tools Get custom tool

{
  "tool_id": "<string>",
  "tool_start_message": "<string>",
  "tool_delayed_message": "<string>",
  "tool_complete_message": "<string>",
  "tool_failed_message": "<string>",
  "openai_tool": {
    "description": "Get the delivery date for a customer's order",
    "name": "get_delivery_date",
    "parameters": {
      "additionalProperties": false,
      "properties": {
        "order_id": {
          "description": "The customer's order ID",
          "type": "string"
        }
      },
      "required": [
        "order_id"
      ],
      "type": "object"
    }
  },
  "additional_tool_info": {
    "tool_type": "custom",
    "api": {
      "endpoint": "https://api.example.com/test",
      "headers": {
        "Content-Type": "application/json"
      },
      "method": "POST",
      "parameters": {
        "fixed_params": {
          "api_key": {
            "description": "API key for authentication",
            "value": "test-api-key"
          }
        },
        "runtime_params": {}
      }
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

API Reference

AI Agents v2

Built-in Tools

Custom Tools

Calls

Post-call Analysis

Phone Numbers

Knowledge Bases

Knowledge Bases v2

Prompt Generation

Public Sharing

API Keys

Path Parameters

Body

Response