Voice agentsAgents
Create agent
Creates an agent. The system prompt is generated from description, industry, designation, company_name, tone, guardrails and conversation_flow, so the call can take a few seconds.
/v2/agents402 when your plan's agent limit is reached.Authorization
AuthorizationstringheaderrequiredBearer authentication header of the form
Bearer <api_key>, where<api_key>is a key from Account Settings → API keys in your dashboard.
Request body
application/json
agent_namestringrequiredName the agent introduces itself with.
llm_providerstringrequiredLLM provider for voice calls.
Allowed:openaianthropicgooglegrokopenrouterazurellm_modelstringrequiredLLM model id, e.g.
gpt-4o-mini.stt_providerstringrequiredSpeech-to-text provider.
Allowed:deepgramopenaistt_modelstringrequiredSpeech-to-text model, e.g.
nova-3.tts_providerstringrequiredText-to-speech provider.
Allowed:sarvamelevenlabssmallestcartesiarimeinworldazurettstts_voicestringrequiredVoice id from the TTS provider.
descriptionstringShort goal of the agent. Drives the generated system prompt.
Default:""industrystringIndustry context.
Default:""designationstringRole the agent plays.
Default:""company_namestringCompany the agent speaks on behalf of.
Default:""languagestringConversation language, e.g.
english,hindi,hinglish,tamil. Must be supported by the STT provider.Default:englishllm_temperaturenumberSampling temperature.
Default:0.7llm_max_tokenintegerMax tokens per reply.
Default:350whatsapp_llm_providerstringLLM provider for the WhatsApp text agent.
whatsapp_llm_modelstringLLM model for the WhatsApp text agent.
whatsapp_llm_temperaturenumberTemperature for WhatsApp replies.
Default:0.7whatsapp_llm_max_tokenintegerMax tokens per WhatsApp reply.
Default:350tts_modelstringTTS model, when the provider has several.
tts_languagestringTTS language code.
Default:entonestringSpeaking tone.
Default:Warm & professionalgreeting_messagestringFirst line on inbound calls.
Default:""outbound_greeting_messagestringFirst line on outbound calls.
Default:""guardrailsstringRules the agent must follow.
Default:""conversation_flowstring[]Ordered conversation steps.
Default:[]closing_messagestringLine used to close the call.
Default:""hangup_promptstringWhen the agent should end the call.
background_soundstringAmbience under the voice.
Allowed:noneoffice_ambienceDefault:noneset_inbound_numberstringOne of your phone numbers (E.164) to route inbound calls to this agent.
set_inbound_whatsapp_numberstringOne of your WhatsApp
phone_number_ids whose messages this agent answers.
Response
The created agent object.
Show all 45 fieldsHide fields
idstring (uuid)Unique identifier of the agent.
tenant_idstring (uuid)The workspace that owns the agent.
agent_namestringName the agent introduces itself with.
descriptionstringShort goal of the agent, used to compose the system prompt.
system_promptstringnullableThe full prompt sent to the LLM. Generated on create; afterwards stored exactly as you send it.
industrystringIndustry context, e.g.
Banking.designationstringRole the agent plays, e.g.
Loan advisor.company_namestringCompany the agent speaks on behalf of.
llm_providerstringLLM provider for voice calls.
Allowed:openaianthropicgooglegrokopenrouterazurellm_modelstringLLM model id, e.g.
gpt-4o-mini.llm_temperaturenumberSampling temperature.
Default:0.7llm_max_tokenintegerMax tokens per LLM reply.
Default:350whatsapp_llm_providerstringnullableLLM provider for the WhatsApp text agent.
whatsapp_llm_modelstringnullableLLM model for the WhatsApp text agent.
whatsapp_llm_temperaturenumberTemperature for the WhatsApp text agent.
Default:0.7whatsapp_llm_max_tokenintegerMax tokens per WhatsApp reply.
Default:350stt_providerstringSpeech-to-text provider.
Allowed:deepgramopenaistt_modelstringSpeech-to-text model, e.g.
nova-3.tts_providerstringText-to-speech provider.
Allowed:sarvamelevenlabssmallestcartesiarimeinworldazurettstts_voicestringVoice id from the TTS provider.
tts_modelstringnullableTTS model, when the provider has several.
tts_languagestringTTS language code.
Default:enlanguagestringnullableConversation language, e.g.
english,hindi,hinglish,tamil. Must be supported by the STT provider.stt_lang_codestringnullableRead-only. Language code derived from
languageand the STT provider.llm_credential_idstring (uuid)nullableRead-only. Your own LLM key (from Providers) used for this agent, if connected.
stt_credential_idstring (uuid)nullableRead-only. Your own STT key used for this agent, if connected.
tts_credential_idstring (uuid)nullableRead-only. Your own TTS key used for this agent, if connected.
tonestringSpeaking tone.
Default:Warm & professionalgreeting_messagestringFirst line spoken on inbound calls.
outbound_greeting_messagestringFirst line spoken on outbound calls.
guardrailsstringRules the agent must follow.
conversation_flowstring[]Ordered steps of the conversation.
closing_messagestringLine used to close the call.
hangup_promptstringnullableWhen the agent should end the call.
background_soundstringAmbience mixed under the voice.
Allowed:noneoffice_ambienceDefault:nonenumber_idstring (uuid)nullableRead-only. Phone number linked for inbound calls.
set_inbound_numberstringnullablePhone number (E.164) that routes inbound calls to this agent.
whatsapp_account_idstring (uuid)nullableRead-only. WhatsApp account linked to this agent.
set_inbound_whatsapp_numberstringnullableWhatsApp
phone_number_idwhose messages this agent answers.post_call_whatsapp_template_namestringnullableRead-only. WhatsApp template sent after a call.
post_call_whatsapp_template_languagestringnullableRead-only. Language of the post-call template.
post_call_whatsapp_template_paramsstring[]Read-only. Variables filled into the post-call template.
is_activebooleanWhether the agent answers calls and messages.
Default:truecreated_atstring (date-time)When the agent was created.
updated_atstring (date-time)When the agent was last changed.