Create an AI assistant
Create an assistant for conversations, support tickets, the help desk, internal AI chat or voice calls.
Endpoint
POST/ai-assistants
Body
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | integer | Yes | Your API key's organization ID. |
name | string | Yes | Display name. |
ai_model_id | integer | Yes | Model ID from AI Models. |
connection | string | Yes | system, organization or specific. The server stores system unless your plan includes your own provider credentials. |
assistant_type | string | No | conversation, support-ticket, helpdesk, ai-chat or voice. |
description | string | No | Short description. |
instructions | string | No | Full system instructions. |
instructions_language | string | No | ENG or ESP. |
is_easy_mode | boolean | No | Guided mode. Default true; send false when you write instructions yourself. |
easy_mode_config | object | null | No | Guided-mode source. Use null for advanced mode. |
timezone | string | No | IANA timezone. Default UTC. |
specific_openai_secret_key | string | No | Provider key used when connection is specific. |
telnyx_ai_assistant_config | object | No | Voice configuration. See Configure a voice assistant. |
Every other writable field of the AI assistant object can also be sent on create; the same shapes as in Update an AI assistant apply. Unknown top-level fields are rejected.
What the server does on create:
- Generates
version_id. voiceassistants getvoice_enabled: trueand, when you send no voice config,telnyx_ai_assistant_config: { "sync_status": "pending", "voice_mode": "unified" }. The voice agent is then synced with the voice provider.ai-chatandhelpdeskassistants get a defaultinternal_toolsset (it replaces anyinternal_toolsyou send).conversation,support-ticketandai-chatassistants getadvanced_options.conversation_summary_config.enabled: trueunless you set it.- Media send flags (
can_send_images, ...) are turned on wheninstructionsreference media from the assistant media library. created_by_user_idis not filled in for API key requests, and no change history entry is recorded.
Request
Create a voice assistant:
Response
The created AI assistant object (shortened):
json
Errors
| Status | When |
|---|---|
400 | A required field is missing, a value is outside its enum or range, an unknown top-level field is sent, or a handoff rule references an invalid user or assistant. |
403 | organization_id is not your API key's organization. |
Report an issue with this documentation
Please log in to report issues with our documentation.