Create tool

Creates a new mid-call tool. After creation, attach the tool to one or more assistants using the tool_ids parameter.

Endpoint

POST /user/tools

Request

string

required

Tool name. Must contain only lowercase letters and underscores, and start with a letter (e.g., get_weather, book_appointment).

string

required

Description of when and how the AI should use this tool. Maximum 255 characters. This description is passed to the AI model.

string

required

Valid URL of the API endpoint to call.

string

required

HTTP method: GET, POST, PUT, PATCH, or DELETE.

integer

default:"10"

Request timeout in seconds. Range: 1–30.

array

HTTP headers to send with the request.

Show Header properties

string

required

Header name.

string

required

Header value.

array

Parameters the AI extracts from the conversation and sends to the endpoint.

Show Schema field properties

string

required

Parameter name. 2–32 characters, must start with a letter, letters and underscores only.

string

required

Parameter type: string, number, or boolean.

string

required

Description to help the AI extract this parameter. 3–255 characters.

Response

string

Confirmation message.

object

The created tool.

Show properties

integer

Unique identifier of the tool.

string

Tool name.

string

Tool description.

string

API endpoint URL.

string

HTTP method.

integer

Request timeout in seconds.

array

HTTP headers.

array

Parameter schema.

string

ISO 8601 creation timestamp.

string

ISO 8601 last update timestamp.

Example

curl -X POST "https://portal.intellixent.ai/api/user/tools" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "check_order_status",
    "description": "Use this tool to check the status of a customer order when they ask about it.",
    "endpoint": "https://api.yourstore.com/orders/status",
    "method": "GET",
    "timeout": 10,
    "headers": [
      {"name": "Authorization", "value": "Bearer sk_..."}
    ],
    "schema": [
      {
        "name": "order_id",
        "type": "string",
        "description": "The customer order ID to check"
      }
    ]
  }'

const response = await fetch('https://portal.intellixent.ai/api/user/tools', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'check_order_status',
    description: "Use this tool to check the status of a customer order when they ask about it.",
    endpoint: 'https://api.yourstore.com/orders/status',
    method: 'GET',
    timeout: 10,
    headers: [{ name: 'Authorization', value: 'Bearer sk_...' }],
    schema: [
      { name: 'order_id', type: 'string', description: 'The customer order ID to check' }
    ]
  })
});

const data = await response.json();
console.log(data.data.id); // New tool ID

201 Created

{
  "message": "Tool created successfully",
  "data": {
    "id": 1,
    "name": "check_order_status",
    "description": "Use this tool to check the status of a customer order when they ask about it.",
    "endpoint": "https://api.yourstore.com/orders/status",
    "method": "GET",
    "timeout": 10,
    "headers": [
      { "name": "Authorization", "value": "Bearer sk_..." }
    ],
    "schema": [
      {
        "name": "order_id",
        "type": "string",
        "description": "The customer order ID to check"
      }
    ],
    "created_at": "2025-10-10T12:00:00.000000Z",
    "updated_at": "2025-10-10T12:00:00.000000Z"
  }
}

422 Invalid name format

{
  "message": "The name field must contain only lowercase letters and underscores, and start with a letter.",
  "errors": {
    "name": ["Tool name must contain only lowercase letters and underscores, and start with a letter."]
  }
}

After creating a tool, attach it to an assistant using the tool_ids parameter in Create assistant or Update assistant.

Overview

Assistants

Calls

Campaigns & Leads

Conversations

Messaging

Phone Numbers

Knowledge & Tools

Webhooks

Endpoint

Request

Response

Example

​Endpoint

​Request

​Response

​Example

Endpoint

Request

Response

Example