Agent Config

{
  "prompt": "<string>",
  "voice": {
    "voice_id": "<string>",
    "model": "<string>",
    "settings": {}
  },
  "flow": {
    "user_start_first": true,
    "interruption": {
      "allowed": true,
      "keep_interruption_message": true,
      "first_messsage": true
    },
    "response_delay": 123,
    "auto_fill_responses": {
      "response_gap_threshold": 123,
      "messages": [
        "<string>"
      ]
    },
    "agent_terminate_call": {
      "enabled": true,
      "instruction": "<string>",
      "messages": [
        "<string>"
      ]
    },
    "voicemail": {
      "message": "<string>",
      "continue_on_voice_activity": true
    },
    "call_transfer": {
      "phone": "<string>",
      "phones": [
        {
          "phone": "<string>",
          "description": "<string>"
        }
      ],
      "instruction": "<string>",
      "messages": [
        "<string>"
      ]
    },
    "inactivity_handling": {
      "idle_time": 123,
      "message": "<string>"
    },
    "dtmf_dial": {
      "enabled": false,
      "instruction": "<string>"
    }
  },
  "first_message": "<string>",
  "tools": [
    {
      "name": "<string>",
      "description": "<string>",
      "params": [
        {
          "name": "<string>",
          "required": true,
          "type": "<string>",
          "description": "<string>"
        }
      ],
      "webhook": "<string>",
      "header": {},
      "method": "<string>",
      "timeout": 123,
      "run_after_call": true,
      "messages": [
        "<string>"
      ],
      "execute_after_message": true,
      "exclude_session_id": true
    }
  ],
  "millis_functions": [
    {
      "name": "<string>",
      "description": "<string>",
      "data": {
        "param": {
          "description": "<string>",
          "name": "<string>",
          "required": true,
          "type": "<string>"
        }
      },
      "type": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ],
  "app_functions": [
    {
      "name": "<string>",
      "credentials": {}
    }
  ],
  "custom_llm_websocket": "<string>",
  "language": "en-US",
  "vad_threshold": 123,
  "llm": {
    "temperature": 0,
    "history_settings": {
      "history_message_limit": 123,
      "history_tool_result_limit": 123
    }
  },
  "session_timeout": {
    "max_duration": 123,
    "max_idle": 123,
    "message": "<string>"
  },
  "session_data_webhook": "<string>",
  "privacy_settings": {
    "opt_out_data_collection": true,
    "do_not_call_detection": false
  },
  "custom_vocabulary": {
    "keywords": {}
  },
  "extra_prompt_webhook": "<string>",
  "switch_language": {
    "languages": [
      "<string>"
    ]
  },
  "knowledge_base": {
    "files": [
      "<string>"
    ],
    "messages": [
      "<string>"
    ]
  },
  "speech_to_text": {
    "multilingual": true,
    "model": "<string>"
  },
  "call_settings": {
    "enable_recording": false,
    "background": {
      "url": "<string>",
      "volume": 123
    }
  },
  "memory": {
    "user_identifier_key": ""
  },
  "timezone": "<string>"
}

prompt

string

required

The primary prompt used to guide the agent's behavior.

voice

Voice · object

required

Detailed voice configuration for the agent.

Show child attributes

flow

Flow · object | null

Settings for conversation flow management.

Show child attributes

first_message

string | null

The agent's opening message for conversations.

tools

Function · object[] | null

List of tools/functions the agent can use.

Show child attributes

millis_functions

MillisFunction · object[] | null

Millis-specific functions for agent customization.

Show child attributes

app_functions

AppFunction · object[] | null

Predefined functions tied to app integrations.

Show child attributes

custom_llm_websocket

string | null

WebSocket URL for custom LLM integration.

language

enum<string> | null

default:en-US

The default language for the agent.

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

vad_threshold

number | null

Voice activity detection threshold for detecting speech.

llm

LLM · object | null

Configuration for the LLM used by the agent.

Show child attributes

session_timeout

SessionTimeout · object | null

Settings related to session duration and idle time.

Show child attributes

session_data_webhook

Webhook for receiving end of session data.

privacy_settings

PrivacySetting · object | null

Settings for user privacy and data collection.

Show child attributes

custom_vocabulary

CustomVocabulary · object | null

Custom vocabulary for improving recognition.

Show child attributes

extra_prompt_webhook

Webhook for providing extra prompts and metadata at the start of a conversation.

switch_language

SwitchLanguage · object | null

Settings for dynamically switching agent language.

Show child attributes

knowledge_base

KnowledgeBase · object | null

Configuration for the agent's knowledge base.

Show child attributes

speech_to_text

SpeechToText · object | null

Speech-to-text configuration for transcription.

Show child attributes

call_settings

CallSettings · object | null

General settings for calls.

Show child attributes

memory

MemoryConfig · object | null

Memory configuration for the agent.

Show child attributes

timezone

string | null

The timezone for the agent's operation.

Overview

Core Concepts

Integration Guides

Telephony