Sign in
Assistants

Create Tool

Create a new custom AI tool that can be attached to AI assistants.

post/ai/tools

Request body

client_side_toolobject
display_namestring required
functionobject
handoffobject
inviteobject
retrievalobject
timeout_msinteger
typestring required
webhookobject

Example request

{
  "update_dynamic_variables": {
    "description": "Collect caller details into conversation variables.",
    "name": "collect_details",
    "updatable_variables": [
      {
        "description": "The caller's full name.",
        "name": "customer_name",
        "type": "string"
      }
    ]
  }
}

Response

Successful Response

created_atstring
display_namestring
idstring required
timeout_msinteger
tool_definitionobject required
typestring required

Changes

Changed in 4 of the 61 revisions of this API.13