Create an AI Assistant

Create a new AI assistant for conversations, support tickets, AI chat, or voice calls.

Endpoint

POST
/ai-assistants

Request

Response

json

Request Parameters

ParameterTypeRequiredDescription
organization_idNumberYesID of the organization that owns the assistant
nameStringYesAssistant display name
assistant_typeStringYesAccepted values used by the configuration UI: conversation, support-ticket, ai-chat, voice
ai_model_idNumberYesAI model ID. Use the AI Models API to list valid models
connectionStringNoModel credential source: system, organization, or specific
specific_openai_secret_keyStringNoProvider key used only when connection is specific
timezoneStringNoIANA timezone used by scheduling and assistant context
instructionsStringNoAdvanced-mode prompt instructions
instructions_languageStringNoENG or ESP
is_easy_modeBooleanNoWhether the assistant uses guided mode
easy_mode_configObject or nullNoGuided-mode source config. Use null for advanced mode
telnyx_ai_assistant_configObject or nullNoVoice runtime configuration for voice assistants

Create a Voice Assistant

Voice assistants use the same endpoint with assistant_type set to voice.

Duplicating an Assistant

The configuration UI duplicates an assistant by creating a new assistant with the same configuration. To duplicate through the API:

  1. Retrieve the source assistant with GET /ai-assistants/:id.
  2. Remove server-managed fields such as id, created_by_user_id, created_at, updated_at, and deleted_at.
  3. Change name and call POST /ai-assistants.

Report an issue with this documentation

Please log in to report issues with our documentation.