Request
This endpoint expects an object.
namestringRequired1-100 characters
Agent name
agent_typestringRequired>=1 character
Agent type: sales, support, custom
sectorstringRequired>=1 character
Industry sector (e.g. Real Estate, Finance & Banking, Healthcare, E-commerce & Retail)
ai_modelstringRequired>=1 character
AI model: lai-premium-2, lai-premium-3, lai-premium-4
languagestringOptional>=1 characterDefaults to English
Agent language: English, Hindi, Tamil, Telugu, Bengali, Gujarati, Kannada, Malayalam, Marathi
descriptionstring or nullOptional>=1 character
Agent description
custom_descriptionstring or nullOptional>=1 character
Custom agent description (required if agent_type=custom)
start_flowstring or nullOptional>=1 character
Opening greeting message. Auto-generated if not provided.
end_flowstring or nullOptional>=1 character
Closing message. Auto-generated if not provided.
tonestring or nullOptional>=1 characterDefaults to professional
Agent tone: professional, friendly, casual, formal
agent_rolestring or nullOptional>=1 character
Agent role title
voicestring or nullOptional>=1 character
Voice gender: male or female
voice_idstring or nullOptional>=1 character
Specific voice ID for TTS
accentstring or nullOptional>=1 character
Voice accent
pronunciationsmap from strings to strings or nullOptional
Custom pronunciation rules {word: pronunciation}
voice_response_settingsobject or nullOptional
Voice & response settings
background_sounds_enabledboolean or nullOptional
Office background sound during calls
promptstring or nullOptional>=1 character
Custom agent prompt/instructions. Auto-generated if not provided.
details_to_collectlist of any or nullOptional
Details to collect during call
brand_namestring or nullOptional>=1 character
typed_knowledgestring or nullOptional>=1 character
Knowledge base text
timezonestring or nullOptional>=1 character
Agent timezone (e.g. Asia/Kolkata)
knowledge_base_idslist of strings or nullOptional
Knowledge bases the agent searches during calls (ids from /v1/knowledge-bases)
webhook_configobject or nullOptional
Webhook configuration
custom_apilist of objects or nullOptional
Custom API tool configs
lookup_apiobject or nullOptional
Pre-call data lookup config
transfer_maplist of objects or nullOptional
Human handoff phone numbers
other_languageslist of strings or nullOptional
Additional languages (e.g. [‘Hindi’, ‘Spanish’])
Response
Successful Response
dataobject
Full agent detail response.
successbooleanOptionalDefaults to true