Telnyx AI: Assistants — Documentation Index
Assistants documentation within the AI section of the Telnyx developer docs (https://developers.telnyx.com). Root index: https://developers.telnyx.com/llms.txt · AI index: https://developers.telnyx.com/development/llms/ai-llms-txt.md · Full content for this subsection: https://developers.telnyx.com/development/llms/ai-assistants-llms-full-txt.md
Guides
- Voice Assistant: Build a voice AI assistant in the Telnyx portal without writing code. Pick a model and voice, attach a phone number, and start taking inbound calls.
- Multi-Participant Calls: Invite additional participants into a live Voice AI call and control when your assistant should speak or stay silent.
- Memory: Give Telnyx AI Assistants long-term memory so they recall caller details across sessions. Configure memory scope, retrieval, and conversation history.
- Dynamic Variables: Personalize Telnyx AI Assistant prompts with dynamic variables. Pass caller context, account data, and CRM fields at runtime into the assistant instructions.
- Conversation Workflows: Design multi-step Telnyx AI Assistant conversations with workflow nodes, conditional routing, per-step instructions, model and voice overrides, and assistant routing.
- Async Tools: Build responsive Telnyx AI Assistants that keep talking while slow backends run. Use async webhooks and the Add Messages API together or independently.
- Filler Messages: Eliminate dead air during synchronous webhook tool calls by configuring scripted filler phrases that play at timed intervals while your backend processes requests.
- Tools Library: Create tools once and share them across all your AI assistants. Migrate legacy tools at your own pace.
- AI Assistants and Edge Compute: Use a Telnyx Edge Compute function as the backend for dynamic variables and webhook tool calls — no separate server required.
- Client-Side Tools: Let your AI assistant call functions that run in the browser during a conversation. Configure client-side tools in the portal and implement handlers with the Telnyx AI Agent library.
- Agent Handoff: Enable seamless AI-to-AI handoffs with specialized assistants working together in a single conversation, providing expert-level support across multiple domains.
- Voicemail Detection on Transfer: Configure Voice AI Assistants to detect voicemail on transferred calls and respond automatically.
- Scheduled Events: Schedule outbound phone calls and SMS messages from Voice AI Assistants, with configurable retry policies for unanswered calls.
- Transcription Settings: Choose and configure speech-to-text (STT) models for AI Assistants, including Deepgram, Azure, AssemblyAI, xAI, and Parakeet models.
- Integrations: Connect Telnyx AI Assistants with enterprise platforms like Salesforce, HubSpot, ServiceNow, Zendesk, Microsoft Teams, Notion, Stripe, and more to automate workflows during conversations.
- Testing, Versions & Traffic Distribution: A/B test Telnyx AI Assistant versions in production. Split traffic across prompts, models, and voices to measure quality before promoting a new version.
- Importing Assistants: Import AI assistants from OpenAI, ElevenLabs, Vapi, and other providers into Telnyx. Migrate prompts, voices, tools, and knowledge bases in a few steps.
- Custom LLMs for Assistants: Configure Azure OpenAI, AWS Bedrock, Baseten, or any OpenAI-compatible endpoint as a custom LLM provider for your Telnyx AI assistants.
Missions
- Voice Outreach: Give your AI agent a mission to research businesses, make phone calls, and report back with results — all tracked and auditable through the Telnyx Missions API.
AI Insights
- Creating insights: Step-by-step guide to creating AI Insights in the Mission Control Portal to analyze your AI Assistant conversations.
- Use cases: Industry-specific examples and implementation patterns for AI Insights across healthcare, customer support, sales, e-commerce, and financial services.
- Structured insights: Create AI Insights with defined JSON schemas for consistent, structured data extraction from conversations.
- Insight groups: Organize AI Insights into reusable groups and configure webhook delivery for automated insights distribution.
- Telnyx-managed insights: Use built-in insights from Telnyx — Agent Instruction Following and User Satisfaction — to measure assistant quality out of the box, no custom configuration needed.
API Reference (Assistants)
Assistants
- List assistants: Retrieve a list of all AI Assistants configured by the user.
- Create an assistant: Create a new AI Assistant.
- Get an assistant: Retrieve an AI Assistant configuration by
assistant_id. - Update an assistant: Update an AI Assistant’s attributes.
- Delete an assistant: Delete an AI Assistant by
assistant_id. - Assistant Chat (BETA): This endpoint allows a client to send a chat message to a specific AI Assistant. The assistant processes the message and returns a relevant reply based on the…
- Assistant Sms Chat: Send an SMS message for an assistant. This endpoint:
- Clone Assistant: Clone an existing assistant, excluding telephony and messaging settings.
- Enhance Assistant Instructions: Enhance an assistant’s instructions using an LLM. The endpoint reads the assistant’s current instructions and tools, then streams back improved instructions as…
- Import assistants from external provider: Import assistants from external providers. Any assistant that has already been imported will be overwritten with its latest version from the importing provider.
- List scheduled events: Get scheduled events for an assistant with pagination and filtering
- Create a scheduled event: Create a scheduled event for an assistant
- Get a scheduled event: Retrieve a scheduled event by event ID
- Delete a scheduled event: If the event is pending, this will cancel the event. Otherwise, this will simply remove the record of the event.
- List assistant tests with pagination: Retrieves a paginated list of assistant tests with optional filtering capabilities
- Create a new assistant test: Creates a comprehensive test configuration for evaluating AI assistant performance
- Get all test suite names: Retrieves a list of all distinct test suite names available to the current user
- Get test suite run history: Retrieves paginated history of test runs for a specific test suite with filtering options
- Trigger test suite execution: Executes all tests within a specific test suite as a batch operation
- Get assistant test by ID: Retrieves detailed information about a specific assistant test
- Update an assistant test: Updates an existing assistant test configuration with new settings
- Delete an assistant test: Permanently removes an assistant test and all associated data
- Get test run history for a specific test: Retrieves paginated execution history for a specific assistant test with filtering options
- Trigger a manual test run: Initiates immediate execution of a specific assistant test
- Get specific test run details: Retrieves detailed information about a specific test run execution
- Get all versions of an assistant: Retrieves all versions of a specific assistant with complete configuration and metadata
- Get a specific assistant version: Retrieves a specific version of an assistant by assistant_id and version_id
- Update a specific assistant version: Updates the configuration of a specific assistant version. Can not update main version
- Delete a specific assistant version: Permanently removes a specific version of an assistant. Can not delete main version
- Promote an assistant version to main: Promotes a specific version to be the main/current version of the assistant. This will delete any existing canary deploy configuration and send all live produc…
- Get Canary Deploy: Endpoint to get a canary deploy configuration for an assistant.
- Create Canary Deploy: Endpoint to create a canary deploy configuration for an assistant.
- Update Canary Deploy: Endpoint to update a canary deploy configuration for an assistant.
- Delete Canary Deploy: Endpoint to delete a canary deploy configuration for an assistant.
- Get assistant texml: Get an assistant texml by
assistant_id. - Test Assistant Tool: Test a webhook tool for an assistant
- Get All Tags
- Add Assistant Tag
- Remove Assistant Tag
- Add Assistant Tool
- Remove Assistant Tool
Integrations
- List Integrations: List all available integrations.
- List User Integrations: List user setup integrations
- Get User Integration connection By Id: Get user setup integrations
- Delete Integration Connection: Delete a specific integration connection.
- List Integration By Id: Retrieve integration details
MCP Servers
- List MCP Servers: Retrieve a list of MCP servers.
- Create MCP Server: Create a new MCP server.
- Get MCP Server: Retrieve details for a specific MCP server.
- Update MCP Server: Update an existing MCP server.
- Delete MCP Server: Delete a specific MCP server.
Missions
- List missions: List all missions for the organization
- Create mission: Create a new mission definition
- List recent events: List recent events across all missions
- List recent runs: List recent runs across all missions
- Get mission: Get a mission by ID (includes tools, knowledge_bases, mcp_servers)
- Update mission: Update a mission definition
- Delete mission: Delete a mission
- Clone mission: Clone an existing mission
- List runs for mission: List all runs for a specific mission
- Start a run: Start a new run for a mission
- Get run details: Get details of a specific run
- Update run: Update run status and/or result
- Cancel run: Cancel a running or paused run
- List events: List events for a run (paginated)
- Log event: Log an event for a run
- Get event details: Get details of a specific event
- Pause run: Pause a running run
- Get plan: Get the plan (all steps) for a run
- Create initial plan: Create the initial plan for a run
- Add step(s) to plan: Add one or more steps to an existing plan
- Get step details: Get details of a specific plan step
- Update step status: Update the status of a plan step
- Resume run: Resume a paused run
- List linked Telnyx agents: List all Telnyx agents linked to a run
- Link Telnyx agent to run: Link a Telnyx AI agent (voice/messaging) to a run
- Unlink Telnyx agent: Unlink a Telnyx agent from a run
- List knowledge bases: List all knowledge bases for a mission
- Create knowledge base: Create a new knowledge base for a mission
- Get knowledge base: Get a specific knowledge base by ID
- Update knowledge base: Update a knowledge base definition
- Delete knowledge base: Delete a knowledge base from a mission
- List MCP servers: List all MCP servers for a mission
- Create MCP server: Create a new MCP server for a mission
- Get MCP server: Get a specific MCP server by ID
- Update MCP server: Update an MCP server definition
- Delete MCP server: Delete an MCP server from a mission
- List tools: List all tools for a mission
- Create tool: Create a new tool for a mission
- Get tool: Get a specific tool by ID
- Update tool: Update a tool definition
- Delete tool: Delete a tool from a mission
Conversations
- List conversations: Retrieve a list of all AI conversations configured by the user. Supports PostgREST-style query parameters for filtering. Examples are included for the standard…
- Create a conversation: Create a new AI Conversation.
- Aggregate Conversation Insights: Aggregate conversation insights by specified fields
- Get Insight Template Groups: Get all insight groups
- Create Insight Template Group: Create a new insight group
- Get Insight Template Group: Get insight group by ID
- Update Insight Template Group: Update an insight template group
- Delete Insight Template Group: Delete insight group by ID
- Assign Insight Template To Group: Assign an insight to a group
- Unassign Insight Template From Group: Remove an insight from a group
- Get Insight Templates: Get all insights
- Create Insight Template: Create a new insight
- Get Insight Template: Get insight by ID
- Update Insight Template: Update an insight template
- Delete Insight Template: Delete insight by ID
- Get a conversation: Retrieve a specific AI conversation by its ID.
- Update conversation metadata: Update metadata for a specific conversation.
- Delete a conversation: Delete a specific conversation by its ID.
- Get insights for a conversation: Retrieve insights for a specific conversation
- Create Message: Add a new message to the conversation. Used to insert a new messages to a conversation manually ( without using chat endpoint )
- Get conversation messages: Retrieve messages for a specific conversation, including tool calls made by the assistant.