Assistants

Update the configuration of an existing AI tool.

patch/ai/tools/{tool_id}

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/ai/tools/{tool_id}
  • Auth: HTTP bearer

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

{
  "pay": {
    "connector_parameters": {
      "campaignid": "abc",
      "customer_ref": "CUST-67890"
    },
    "valid_card_types": [
      "visa",
      "mastercard"
    ]
  },
  "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

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property