Chat Completions

Headers

authorization

string | null

Private Key

Body

application/json

agent

object

required

Show child attributes

agent.agent_id

string | null

agent.agent_config

object | null

Show child attributes

agent.agent_config.prompt

string | null

agent.agent_config.voice

object | null

Show child attributes

agent.agent_config.voice.provider

enum<string>

required

Provider of text to speech.

Available options:

elevenlabs,

openai,

cartesia,

playht,

deepgram,

rime,

neets,

openai_realtime,

dubverse

agent.agent_config.voice.voice_id

string

required

The ID of the voice selected for the agent

agent.agent_config.voice.model

string | null

The ElevenLabs model name (e.g., 'eleven_turbo_v2_5')

agent.agent_config.voice.settings

object | null

ElevenLabs-specific voice settings such as stability and similarity_boost

agent.agent_config.flow

object | null

Show child attributes

agent.agent_config.flow.user_start_first

boolean | null

agent.agent_config.flow.interruption

object | null

Show child attributes

agent.agent_config.flow.interruption.allowed

boolean | null

agent.agent_config.flow.interruption.keep_interruption_message

boolean | null

agent.agent_config.flow.interruption.first_messsage

boolean | null

agent.agent_config.flow.response_delay

agent.agent_config.flow.auto_fill_responses

object | null

Show child attributes

agent.agent_config.flow.auto_fill_responses.messages

string[]

required

agent.agent_config.flow.auto_fill_responses.response_gap_threshold

integer

required

agent.agent_config.flow.agent_terminate_call

object | null

Show child attributes

agent.agent_config.flow.agent_terminate_call.enabled

boolean

required

agent.agent_config.flow.agent_terminate_call.messages

string[] | null

agent.agent_config.flow.agent_terminate_call.instruction

string | null

agent.agent_config.flow.voicemail

object | null

Show child attributes

agent.agent_config.flow.voicemail.action

enum<string>

required

Available options:

hangup,

message

agent.agent_config.flow.voicemail.message

string | null

agent.agent_config.flow.voicemail.continue_on_voice_activity

boolean | null

agent.agent_config.flow.call_transfer

object | null

Show child attributes

agent.agent_config.flow.call_transfer.phone

string

required

agent.agent_config.flow.call_transfer.messages

string[]

required

agent.agent_config.flow.call_transfer.instruction

string | null

agent.agent_config.first_message

string | null

agent.agent_config.tools

object[] | null

Show child attributes

agent.agent_config.tools.name

string

required

agent.agent_config.tools.description

string

required

agent.agent_config.tools.webhook

string | null

required

agent.agent_config.tools.params

object[] | null

Show child attributes

agent.agent_config.tools.params.name

string

required

agent.agent_config.tools.params.required

boolean

required

agent.agent_config.tools.params.type

string

required

agent.agent_config.tools.params.description

string

required

agent.agent_config.tools.header

object | null

Show child attributes

agent.agent_config.tools.header.{key}

string

agent.agent_config.tools.method

string | null

agent.agent_config.tools.run_after_call

boolean | null

agent.agent_config.tools.messages

string[] | null

agent.agent_config.tools.execute_after_message

boolean | null

agent.agent_config.millis_functions

object[] | null

Show child attributes

agent.agent_config.millis_functions.name

string

required

agent.agent_config.millis_functions.description

string

required

agent.agent_config.millis_functions.data

object

required

Show child attributes

agent.agent_config.millis_functions.data.param

object

required

Show child attributes

agent.agent_config.millis_functions.type

string

required

agent.agent_config.millis_functions.messages

string[] | null

agent.agent_config.app_functions

object[] | null

Show child attributes

agent.agent_config.app_functions.name

string

required

agent.agent_config.app_functions.credentials

object | null

Show child attributes

agent.agent_config.app_functions.credentials.{key}

string

agent.agent_config.custom_llm_websocket

string | null

agent.agent_config.language

enum<string> | null

Available options:

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

agent.agent_config.vad_threshold

number | null

agent.agent_config.llm

object | null

Show child attributes

agent.agent_config.llm.model

enum<string>

required

Available options:

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

agent.agent_config.session_timeout

object | null

Show child attributes

agent.agent_config.session_timeout.max_duration

number | null

agent.agent_config.session_timeout.max_idle

number | null

agent.agent_config.session_timeout.message

string | null

agent.agent_config.session_data_webhook

agent.agent_config.privacy_settings

object | null

Show child attributes

agent.agent_config.privacy_settings.opt_out_data_collection

boolean

required

agent.agent_config.custom_vocabulary

object | null

Show child attributes

agent.agent_config.custom_vocabulary.keywords

object

required

Show child attributes

agent.agent_config.custom_vocabulary.keywords.{key}

integer

agent.agent_config.extra_prompt_webhook

agent.agent_config.switch_language

object | null

Show child attributes

agent.agent_config.switch_language.languages

string[]

required

agent.agent_config.knowledge_base

object | null

Show child attributes

agent.agent_config.knowledge_base.files

string[] | null

agent.agent_config.knowledge_base.messages

string[] | null

agent.agent_config.speech_to_text

object | null

Show child attributes

agent.agent_config.speech_to_text.provider

enum<string> | null

Available options:

deepgram,

gladia,

talkscriber

agent.agent_config.speech_to_text.multilingual

boolean | null

agent.agent_config.call_settings

object | null

Show child attributes

agent.agent_config.call_settings.enable_recording

boolean

default:false

agent.agent_config.timezone

string | null

agent.metadata

object | null

agent.include_metadata_in_prompt

boolean | null

messages

object[]

required

• UserMessage
• AssistantMessage
• ToolMessage

Show child attributes

messages.role

enum<string>

required

Available options:

user

messages.content

string

required

Response

200

text/event-stream

Successful response with streaming data

The response is of type file.