Sign in
Assistants

Update Tool

Update the configuration of an existing AI tool.

patch/ai/tools/{tool_id}

Path parameters

tool_idstring required

Unique identifier of the tool.

Request body

typestring
display_namestring
functionobject
retrievalobject
handoffobject
inviteobject
webhookobject
client_side_toolobject
timeout_msinteger

Example request

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

Response

Successful Response

idstring required
typestring required
display_namestring
tool_definitionobject required
timeout_msinteger
created_atstring

Changes

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

Of the 99 revisions, 1 has no diff computed.