AI Assistants API
Configure AI assistants through the AchieveApex REST API.
Overview
The AI Assistants API lets you create, update, duplicate, delete, restore, and audit assistants used for conversations, support tickets, AI chat, and voice calls. Anything configured in the AI assistant settings page is stored on the assistant record or on a related resource documented in this section.
Base Endpoint: /ai-assistants
Assistant Object
json
Assistant Types
| Type | Description |
|---|---|
conversation | Assistant used in customer conversations |
support-ticket | Assistant used in support ticket workflows |
ai-chat | Internal AI chat assistant |
voice | Voice assistant backed by voice runtime configuration |
Configuration Areas
| UI Area | API Field or Related Endpoint |
|---|---|
| Basic settings | name, ai_model_id, connection, specific_openai_secret_key, timezone |
| Instructions | instructions, instructions_language, is_easy_mode, easy_mode_config |
| Human handoff | human_handoff_config |
| AI assistant handoff | ai_assistant_handoff_config |
| Voice external handoff | external_handoff_targets, telnyx_ai_assistant_config.transfer_from_number, telnyx_ai_assistant_config.external_transfer_caller_id_mode |
| Follow-up | follow_up_config |
| Automations | access_permissions_automations |
| Entity access | access_permissions_contact, access_permissions_deals, access_permissions_customer_support |
| Skills | /ai-assistant-skills |
| Advanced options | advanced_options, additional_json_keys, response_config, disable_reply, analyze_images, enable_message_burst_handling, can_send_images |
| Schedule | schedule_config |
| Internal tools | internal_tools |
| API tools | /api-tools plus assistant api_tools associations |
| MCP tools | mcp_tools plus /mcp-tool-connection-proxy |
| Voice | telnyx_ai_assistant_config, acting_user_id, voice helper endpoints |
| History | /ai-assistants-change-history, /ai-assistants-restore-from-changes-history |
Related Documentation
Report an issue with this documentation
Please log in to report issues with our documentation.