Call Management
Conversational AI
Agents
Campaigns
API Reference
Call Management
Conversational AI
Agents
Chat Completions
Headers
Private Key
Body
General settings for calls.
Specifies whether call recording is enabled.
WebSocket URL for custom LLM integration.
Webhook for providing extra prompts and metadata at the start of a conversation.
The agent's opening message for conversations.
Settings for conversation flow management.
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 for predefined agent responses when there are response gaps.
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.
Settings for handling user inactivity during the call.
Settings related to handling interruptions during the agent's responses.
Indicates if user interruptions are allowed during the agent's response.
Defines if interruptions are allowed during the agent's initial message.
Specifies whether to keep the interrupted message in the response.
Configures delays for agent responses.
Determines if the user speaks first to initiate the conversation.
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 Determines if the agent continues the conversation on voice activity during voicemail handling.
The message to leave as voicemail if the agent opts to do so.
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 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.
Millis-specific functions for agent customization.
Data required for the function, including parameters.
Details of a parameter for a Webform function.
A description of what the function does.
The name of the Webform function.
Type of the function (e.g., webform, webhook).
Predefined messages for agent to say while executing the function.
Settings for user privacy and data collection.
Indicates if the user wants to opt out of data collection.
Specifies whether Do Not Call detection is enabled. When enabled, the agent will detect if the user wants to opt-out of future calls or be added to a Do Not Call list.
The prompt used to configure the agent's behavior.
Webhook for receiving end of session data.
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.
Speech-to-text configuration for transcription.
Settings for dynamically switching agent language.
List of languages supported for dynamic switching during the conversation.
The timezone for the agent's operation.
List of tools/functions the agent can use.
A description of the function's purpose.
The name of the function.
Indicates if the session ID should not be included in the webhook request.
Indicates if the function starts executing only after a predefined message is played.
Headers to include in the webhook request.
Predefined messages for agent to say while executing the function.
HTTP method to use for the webhook (e.g., POST, GET).
List of parameters required by the function.
A description of the parameter.
The parameter name for a function.
Indicates if the parameter is required.
The data type of the parameter.
Specifies if the function should only run after the call ends.
The webhook URL to trigger the function.
Voice activity detection threshold for detecting speech.
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.
Response
The response is of type file.