Skip to content

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

AuthorizationstringRequired
ApiKey $ENTROVOX_KEY. Keys are issued per organization.

Path parameters

agent_idstringRequired

Returns

200 OKSuccessful Response

background_soundstringMay be absent

Default none

call_handling_instructionsstring or nullMay be absent
call_objectivestring or nullMay be absent
compliance_configobject or nullMay be absent
Free-form key and value pairs.
created_atstring (date-time)Always present
custom_system_promptstring or nullMay be absent
descriptionstring or nullMay be absent
expressive_modebooleanMay be absent

Default false

flow_configobject or nullMay be absent
Free-form key and value pairs.
idstringAlways present
is_activeboolean or nullMay be absent
llm_modelstring or nullMay be absent
llm_providerstring or nullMay be absent
namestringAlways present
objectivestringMay be absent

Default lead_qualification

opening_linestring or nullMay be absent
opening_line_esstring or nullMay be absent
opening_line_inboundstring or nullMay be absent
organization_idstring or nullMay be absent
parent_agent_idstring or nullMay be absent
personastring or nullMay be absent
prompt_modestringMay be absent

Default assembled

qualification_criteriaobject or nullMay be absent
Free-form key and value pairs.
runtime_configobject or nullMay be absent
Free-form key and value pairs.
screener_responsestring or nullMay be absent
spoken_agency_namestring or nullMay be absent
statusstring or nullMay be absent
tool_policyobject or nullMay be absent
Free-form key and value pairs.
updated_atstring (date-time)Always present
voice_idstring or nullMay be absent
voicemail_message_templatestring or nullMay be absent
voicemail_message_template_esstring or nullMay be absent
voicemail_modestringMay be absent

Default drop

Errors

  • 404VOICE_AGENT_NOT_FOUND

    No AI voice agent with that id in your organization.

    Retrying will fail the same way. Fix the request, or contact us.

  • 422VALIDATION_ERROR

    A 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.