AI voice agents
Retrieve an AI voice agent
GET/v1/voice-agents/{agent_id}
Get one AI voice agent by id.
On this page
Headers
AuthorizationstringRequiredApiKey $ENTROVOX_KEY. Keys are issued per organization.Path parameters
agent_idstringRequiredReturns
200 OKSuccessful Response
background_soundstringMay be absentDefault none
call_handling_instructionsstring or nullMay be absentcall_objectivestring or nullMay be absentcompliance_configobject or nullMay be absentFree-form key and value pairs.
created_atstring (date-time)Always presentcustom_system_promptstring or nullMay be absentdescriptionstring or nullMay be absentexpressive_modebooleanMay be absentDefault false
flow_configobject or nullMay be absentFree-form key and value pairs.
idstringAlways presentis_activeboolean or nullMay be absentllm_modelstring or nullMay be absentllm_providerstring or nullMay be absentnamestringAlways presentobjectivestringMay be absentDefault lead_qualification
opening_linestring or nullMay be absentopening_line_esstring or nullMay be absentopening_line_inboundstring or nullMay be absentorganization_idstring or nullMay be absentparent_agent_idstring or nullMay be absentpersonastring or nullMay be absentprompt_modestringMay be absentDefault assembled
qualification_criteriaobject or nullMay be absentFree-form key and value pairs.
runtime_configobject or nullMay be absentFree-form key and value pairs.
screener_responsestring or nullMay be absentspoken_agency_namestring or nullMay be absentstatusstring or nullMay be absenttool_policyobject or nullMay be absentFree-form key and value pairs.
updated_atstring (date-time)Always presentvoice_idstring or nullMay be absentvoicemail_message_templatestring or nullMay be absentvoicemail_message_template_esstring or nullMay be absentvoicemail_modestringMay be absentDefault drop
Errors
- 404
VOICE_AGENT_NOT_FOUNDNo AI voice agent with that id in your organization.
Retrying will fail the same way. Fix the request, or contact us.
- 422
VALIDATION_ERRORA field is missing or invalid, such as a bad E.164 phone or a missing external_id. param names the field.
Retrying will fail the same way. Fix the request, or contact us.
Any request can also return AUTHENTICATION_REQUIRED, TOKEN_INVALID, API_KEY_EXPIRED, RATE_LIMIT_EXCEEDED or INTERNAL_ERROR.