Call Management
Conversational AI
Agents
Campaigns
API Reference
Call Management
Conversational AI
Agents
Create Sip
Client Token
Private Key
The prompt used to configure the agent's behavior.
Configuration for the agent's voice.
The TTS provider for generating the agent's voice.
The unique identifier for the voice used by the agent.
The model name provided by ElevenLabs (e.g., 'eleven_turbo_v2_5') for voice generation.
Additional voice_settings for ElevenLabs voice, such as stability and similarity boost values.
Settings for conversation flow management.
Determines if the user speaks first to initiate the conversation.
Settings related to handling interruptions during the agent's responses.
Configures delays for agent responses.
Settings for predefined agent responses when there are response gaps.
Configuration for enabling the agent to terminate calls autonomously.
Settings related to handling voicemail scenarios.
Configuration for transferring calls to another phone number.
The agent's opening message for conversations.
List of tools/functions the agent can use.
Millis-specific functions for agent customization.
Predefined functions tied to app integrations.
WebSocket URL for custom LLM integration.
The default language for the agent.
Voice activity detection threshold for detecting speech.
Configuration for the LLM used by the agent.
The language model provider used for generating responses.
Temperature setting for response variability.
Settings related to session duration and idle time.
Maximum call duration (in seconds) before ending the session.
Maximum idle time (in seconds) with no user input before ending the session.
Message to play when the session times out.
Webhook for receiving end of session data.
Settings for user privacy and data collection.
Indicates if the user wants to opt out of data collection.
Custom vocabulary for improving recognition.
Custom keywords with their associated weights for ASR prioritization.
Webhook for providing extra prompts and metadata at the start of a conversation.
Settings for dynamically switching agent language.
List of languages supported for dynamic switching during the conversation.
Configuration for the agent's knowledge base.
List of files used as knowledge sources for the agent.
Predefined messages for agent to say while looking into knowledge base.
Speech-to-text configuration for transcription.
The STT provider for transcribing speech into text.
Indicates if the STT supports multiple languages at the same time.
General settings for calls.
Specifies whether call recording is enabled.
The timezone for the agent's operation.
Body
The prompt used to configure the agent's behavior.
Configuration for the agent's voice.
The TTS provider for generating the agent's voice.
elevenlabs, openai, cartesia, playht, deepgram, rime, neets, openai_realtime, dubverse The unique identifier for the voice used by the agent.
The model name provided by ElevenLabs (e.g., 'eleven_turbo_v2_5') for voice generation.
Additional voice_settings for ElevenLabs voice, such as stability and similarity boost values.
Settings for conversation flow management.
Determines if the user speaks first to initiate the conversation.
Settings related to handling interruptions during the agent's responses.
Indicates if user interruptions are allowed during the agent's response.
Specifies whether to keep the interrupted message in the response.
Defines if interruptions are allowed during the agent's initial message.
Configures delays for agent responses.
Settings for predefined agent responses when there are response gaps.
The time (in milliseconds) before the agent uses an auto-fill response.
Predefined messages for the agent to use when there are response gaps.
Configuration for enabling the agent to terminate calls autonomously.
Specifies whether the agent can end the call autonomously.
Custom instructions for the agent on when to terminate the call.
List of messages the agent may use before ending a call.
Settings related to handling voicemail scenarios.
The action to take when a voicemail is detected, e.g., hang up or leave a message.
hangup, message The message to leave as voicemail if the agent opts to do so.
Determines if the agent continues the conversation on voice activity during voicemail handling.
Configuration for transferring calls to another phone number.
The phone number to transfer the call to.
Instructions for the agent on how to handle the call transfer.
Predefined messages for the agent to say before initiating the call transfer.
The agent's opening message for conversations.
List of tools/functions the agent can use.
The name of the function.
List of parameters required by the function.
The parameter name for a function.
Indicates if the parameter is required.
The data type of the parameter.
A description of the parameter.
A description of the function's purpose.
The webhook URL to trigger the function.
Headers to include in the webhook request.
HTTP method to use for the webhook (e.g., POST, GET).
Specifies if the function should only run after the call ends.
Predefined messages for agent to say while executing the function.
Indicates if the function starts executing only after a predefined message is played.
Indicates if the session ID should not be included in the webhook request.
Millis-specific functions for agent customization.
The name of the Webform function.
A description of what the function does.
Data required for the function, including parameters.
Details of a parameter for a Webform function.
Type of the function (e.g., webform, webhook).
Predefined messages for agent to say while executing the function.
Predefined functions tied to app integrations.
WebSocket URL for custom LLM integration.
The default language for the agent.
ln, cy, wo, cs, hy, nl, ceb, la, en-NZ, ss, lt, ne, fy, oc, yi, tt, bn, fr-CA, sw, th, ms, ka, pa, fi, ig, af, multi, eu, bs, ps, en-AU, si, ff, de, mt, km, pl, nl-BE, fr, en-IN, no, gu, lo, sk, ht, tk, bg, mn, su, ko, it, id, tl, zu, pt-BR, jv, et, ca, sl, ja, lb, gl, zh-TW, hi, ha, th-TH, lv, ast, sq, tr, ar, sv, haw, tg, lg, ba, mk, vi, hu, el, mi, en-US, kn, az, he, hr, ml, kk, es, br, sr, xh, uk, as, ilo, ru, gd, yo, da, sa, fa, es-419, bo, ur, my, nn, mo, so, mr, tn, sd, sn, uz, de-CH, fo, en-GB, zh, ro, pt, or, ga, ta, mg, en, be, am, te, is Voice activity detection threshold for detecting speech.
Configuration for the LLM used by the agent.
The language model provider used for generating responses.
gpt-3.5-turbo, gpt-4-turbo, gpt-4o-realtime-preview, gpt-4o, gpt-4o-mini, llama-3-70b, llama-3-1-8b, llama-3-1-70b, llama-3-1-405b, mistral-large-2407, l3.1-70b-euryale-v2.2 Temperature setting for response variability.
Settings related to session duration and idle time.
Maximum call duration (in seconds) before ending the session.
Maximum idle time (in seconds) with no user input before ending the session.
Message to play when the session times out.
Webhook for receiving end of session data.
Settings for user privacy and data collection.
Indicates if the user wants to opt out of data collection.
Webhook for providing extra prompts and metadata at the start of a conversation.
Settings for dynamically switching agent language.
List of languages supported for dynamic switching during the conversation.
Speech-to-text configuration for transcription.
General settings for calls.
Specifies whether call recording is enabled.
The timezone for the agent's operation.
Response
The response is of type any.