Assistants

Create Tool

Changed on

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

post/ai/tools

Request

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

Headers

Idempotency-Keystring

Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores. Generate a unique UUID v4 for each operation and reuse it only when retrying that operation with the same request. Invalid headers—including duplicate, empty, malformed, or overlong values—return 400 with error code 10015. A request already in progress with the same key returns 409; reusing the key with a different request returns 422. Only successful responses are replayed, for up to 24 hours. Do not include sensitive data in the key.

Request body

typestring required
display_namestring required
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

  • da303e40b51eRevision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

  • 9621f6123ebcRevision changes
    • warning

      added the new 10011 enum value to the // response property for the response status

    • warning

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status