Access Tokens1

Addresses6

Advanced Number Orders4

AI Collections14

Anthropic Messages1

Assistants46

Audio1

Audit Logs1

Authentication Providers5

AutoRechargePreferences2

Billing1

Billing Groups5

Bot Signup4

Brands16

Bucket SSL Certificate3

Bucket Usage2

Bulk Phone Number Campaigns3

Bulk Phone Number Operations5

Bundles2

Call Commands42

Call Control Applications5

Call Information2

Call Recordings11

Campaign15

CDR Reports10

CDR Usage Reports9

Chat4

cloudfs filesystems6

Clusters5

Comments2

Conference Commands23

Connections3

Contents1

Conversation Histories1

Conversations21

Country Coverage2

Coverage1

Credential Connections6

Credentials5

CSV Downloads3

Customer Service Record4

Data Migration9

Debugging1

Decision Models1

Detail Records1

Dialogflow Integration4

DIR References3

Display Identity Records8

Documents8

Dynamic Emergency Addresses4

Dynamic Emergency Endpoints4

Email Domain DNS Records2

Email Domains7

Email Drafts8

Email Events2

Email Inboxes19

Email Messages11

Email Suppression Imports2

Email Suppressions6

Email Templates7

Email Threads2

Email Unsubscribe Groups8

Email Validations3

Email Verification3

Email Webhooks5

Embeddings8

Enterprises6

Enum1

External Connections23

Fine Tuning4

FQDN Connections7

FQDNs5

functions7

Global IPs21

Hosted Numbers9

Inexplicit Number Orders3

Infringement Claims4

Integration Secrets3

Integrations5

Inventory Level1

IP Addresses4

IP Connections5

IP Ranges3

IPs5

kv keys4

kv namespaces4

Machine Payments1

Managed Accounts8

MCP Servers5

MDR Detail Reports1

MDR Detailed Reports8

MDR Usage Reports13

Media Storage API6

Meeting Session Actions3

Meeting Session Artifacts3

Meeting Session Data4

Meeting Sessions5

Memory4

Messages11

Messaging15

Messaging URL Domains1

Missions41

Mobile Network Operators1

Mobile Number Settings2

Mobile Phone Numbers3

Mobile Voice Connections5

Networks9

Noise Suppression Engines1

Notifications16

Number Lookup1

Number Portout14

Number Settings7

numbers features1

OAuth Clients10

OAuth Discovery2

OAuth Grants6

OAuth Protocol7

OpenAI Chat3

OpenAI Embeddings2

Operations1

Opt-Out Management6

Organization Users4

OTA updates2

Outbound Voice Profiles5

Phone Number Batches2

Phone Number Block Orders3

Phone Number Blocks Background Jobs3

Phone Number Campaigns5

Phone Number Configurations11

Phone Number Orders21

Phone Number Porting1

Phone Number Reservations4

Phone Number Search2

Phone Numbers3

Porting Orders53

Presigned Object URLs1

Pricing2

Private Wireless Gateways4

Profiles11

Programmable Fax Applications5

Programmable Fax Commands6

Pronunciation Dictionaries5

Public Internet Gateways4

Push Credentials4

Queue Commands9

RCS9

RCS Agents10

RCS Brands5

Reference Data3

Regions1

Regulatory Requirements3

Reporting8

Reports2

Reputation17

Requirement Groups10

Requirement Types2

Requirements4

Research2

Room Compositions4

Room Participants2

Room Recordings4

Room Sessions7

Rooms6

Rooms Client Tokens2

Session Analysis3

SETI Observability1

Settings2

Shared Campaigns5

Short Codes3

SIM Card Actions4

SIM Card Group Actions2

SIM Card Groups9

SIM Card Orders4

SIM Cards26

SIPREC Connectors4

Sources3

Speech to Text Batch Reports8

Speech To Text Capabilities1

Speech To Text over WebSockets1

Speech to text Usage Reports2

sql databases5

Stored Payment Transactions1

Telco Data Usage Reports8

Terms of Service6

TeXML Applications5

TeXML REST Commands35

Text To Speech Commands3

Traffic Policy Profiles12

UAC Connections6

Usage Reports (BETA)2

User Bundles6

User Tags1

UserAddresses6

Verification Requests7

Verified Numbers5

Verify16

Virtual Cross Connects7

Voice Channels6

Voice Clones6

Voice Designs7

Voice SDK Stats2

Voicemail3

WDR Detail Reports1

Web Search1

Webhooks2

Whatsapp Business Accounts14

Whatsapp Message Templates10

Whatsapp messaging1

Whatsapp Phone Numbers32

WireGuard Interfaces10

Wireless Blocklists6

Wireless Regions1

x402 Payment Transactions4

Webhooks

Callbacks91

Meeting Session Webhooks5

Assistants

Get a specific assistant version

Retrieves a specific version of an assistant by assistant_id and version_id

get/ai/assistants/{assistant_id}/versions/{version_id}

Path parameters

assistant_idstring required

Unique identifier of the assistant.

version_idstring required

Unique identifier of the version.

Query parameters

include_mcp_serversboolean

Whether to include MCP servers in the response.

Response

Returns the specific assistant version configuration

idstring required

namestring required

created_atstring date-time required

version_idstring

Identifier for the assistant version returned by version-aware assistant endpoints.

version_created_atstring date-time

Timestamp when this assistant version was created.

descriptionstring

modelstring required

ID of the model to use when external_llm is not set. You can use the Get models API to see available models. If external_llm is provided, the assistant uses external_llm instead of this field. If neither model nor external_llm is provided, Telnyx applies the default model.

instructionsstring required

System instructions for the assistant. These may be templated with dynamic variables

greetingstring

Text that the assistant will use to start the conversation. This may be templated with dynamic variables. Use an empty string to have the assistant wait for the user to speak first. Use the special value <assistant-speaks-first-with-model-generated-message> to have the assistant generate the greeting based on the system instructions.

llm_api_key_refstring

This is only needed when using third-party inference providers selected by model. The identifier for an integration secret /v2/integration_secrets that refers to your LLM provider's API key. For bring-your-own endpoint authentication, use external_llm.llm_api_key_ref instead. Warning: Free plans are unlikely to work with this integration.

enabled_featuresEnabledFeatures[]

dynamic_variables_webhook_urlstring

If dynamic_variables_webhook_url is set, Telnyx sends a POST request to this URL at the start of the conversation to resolve dynamic variables. Gotcha: the webhook response must wrap variables under a top-level dynamic_variables object, e.g. {"dynamic_variables": {"customer_name": "Jane"}}. Returning a flat object will be ignored and variables will fall back to their defaults. See the dynamic variables guide for the full request/response format and timeout behavior.

dynamic_variables_webhook_timeout_msinteger

Timeout in milliseconds for the dynamic variables webhook. Must be between 1 and 10000 ms. If the webhook does not respond within this timeout, the call proceeds with default values. See the dynamic variables guide.

dynamic_variablesobject

Map of dynamic variables and their values

version_namestring

Human-readable name for the assistant version.

related_mission_idsstring[]

IDs of missions related to this assistant.

tagsstring[]

Tags associated with the assistant. Tags can also be managed with the assistant tag endpoints.

Example response

{
  "tools": [
    {
      "webhook": {
        "url": "https://example.com/api/v1/function",
        "body_parameters": {
          "properties": {
            "age": {
              "description": "The age of the customer.",
              "type": "integer"
            },
            "location": {
              "description": "The location of the customer.",
              "type": "string"
            }
          },
          "required": [
            "age",
            "location"
          ],
          "type": "object"
        },
        "path_parameters": {
          "properties": {
            "id": {
              "description": "The id of the customer.",
              "type": "string"
            }
          },
          "required": [
            "id"
          ],
          "type": "object"
        },
        "query_parameters": {
          "properties": {
            "page": {
              "description": "The page number.",
              "type": "integer"
            }
          },
          "required": [
            "page"
          ],
          "type": "object"
        },
        "preset_body_fields": {
          "account_id": "{{customer_id}}",
          "source": "telnyx-assistant"
        },
        "preset_query_params": {
          "caller": "{{telnyx_end_user_target}}",
          "channel": "voice"
        },
        "messages": [
          {
            "type": "request_start",
            "content": "Let me look that up for you."
          },
          {
            "type": "request_response_delayed",
            "content": "Still working on that.",
            "timing_ms": 5000
          }
        ]
      }
    }
  ],
  "a2a_agents": [
    {
      "name": "billing_agent",
      "url": "https://agents.example.com",
      "headers": [
        {
          "name": "X-Api-Key",
          "value": "{{#integration_secret}}my_agent_api_key{{/integration_secret}}"
        }
      ],
      "timeout_ms": 30000,
      "poll_interval_ms": 500
    }
  ],
  "conversation_flow": {
    "edges": [
      {
        "condition": {
          "prompt": "The caller is asking about a bill or charge.",
          "type": "llm"
        },
        "id": "e_intake_to_billing",
        "start_node_id": "n_intake",
        "target": {
          "node_id": "n_billing",
          "type": "node"
        }
      },
      {
        "condition": {
          "prompt": "The caller has explicitly asked for a human.",
          "type": "llm"
        },
        "id": "e_intake_to_escalation_assistant",
        "start_node_id": "n_intake",
        "target": {
          "assistant_id": "assistant-human-handoff",
          "position": {
            "x": 600,
            "y": 80
          },
          "type": "assistant",
          "voice_mode": "distinct"
        }
      }
    ],
    "nodes": [
      {
        "type": "prompt",
        "id": "n_intake",
        "instructions": "Greet the caller and ask what they're calling about.",
        "name": "Intake",
        "position": {
          "x": 120,
          "y": 80
        },
        "shared_tool_ids": [
          "tool-faq-kb"
        ]
      },
      {
        "type": "prompt",
        "id": "n_billing",
        "instructions": "Focus on billing questions. Look up the caller's latest invoice with the billing tool before answering.",
        "instructions_mode": "append",
        "model": "moonshotai/Kimi-K2.6",
        "name": "Billing",
        "position": {
          "x": 420,
          "y": 80
        },
        "shared_tool_ids": [
          "tool-billing-lookup"
        ],
        "tools_mode": "append"
      }
    ],
    "start_node_id": "n_intake"
  }
}

Changes

Changed in 17 of the 99 revisions of this API.122089

Sep 25, 202688a6ea09277733See the full diff
- ●
  removed the optional property ///////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //// from the response with the status
  response-optional-property-removed
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
Sep 24, 20269a704d4870359See the full diff
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Sep 21, 20261581f4d445662See the full diff
- ●
  added the new omi-health/omi-med-stt-v1 enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new omi-health/omi-med-stt-v1 enum value to the / response property for the response status
  response-property-enum-value-added
Sep 21, 2026d18924181c6e1See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 17, 20264596ec306e592See the full diff
- ●
  added the new assemblyai/universal-3-5-pro enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new assemblyai/universal-3-5-pro enum value to the / response property for the response status
  response-property-enum-value-added
Sep 17, 2026c44ea87f727b339See the full diff
- ▲
  added to the ////// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the ///// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the / response property oneOf list for the response status
  response-property-one-of-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  removed from the ////// response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed from the ///// response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed from the / response property oneOf list for the response status
  response-property-one-of-removed
Sep 16, 202688030e1b5f1b1See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Sep 16, 2026a6a61a29ecdd528See the full diff
- ●
  added the new aicoustics enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new cohere/ar-stt enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new cohere/ar-stt enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new soniox/stt-rt-v5 enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new soniox/stt-rt-v5 enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 17, 20261571b0380bd71See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 4, 2026ca70e22d0d633See the full diff
- ▲
  added to the ////// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the ///// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the / response property oneOf list for the response status
  response-property-one-of-added

Of the 99 revisions, 1 has no diff computed.

Full history (17 revisions)