API ReferenceAgents

Get an agent

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

agent_idstringRequired

Response

Agent details
agent_idstring
workspace_idstring
display_namestring
descriptionstring
languagestring
ai_providerstring
ai_modelstring
tts_voicestring

The voice the agent speaks with. This is a voice_id from GET /v1/voice/models (e.g. aura-asteria-en). Null/absent means the platform-default voice.

system_promptstring
webhook_urlstring
greeting_textstring
Custom greeting played via TTS when a call connects. If null, a default greeting is used.
greeting_audio_urlstring

The source URL of a hosted WAV played as the greeting instead of greeting_text. Set via UpdateAgent; validated and stored at save time. The system-managed storage key is never returned.

tool_definitionsstringDefaults to []

JSON array of OpenAI-compatible function/tool definitions. The AI can invoke these tools during voice calls. Built-in tools: hang_up, transfer_call, hold_call, resume_call. Custom tools are dispatched to the agent’s webhook_url. Defaults to ”[]”.

shareableboolean

When true, enables a public ‘try my agent’ link for browser-based test calls.

knowledge_base_idstring

Attached knowledge base (RAG). When set, hosted-AI turns answer from this KB’s documents. Empty/absent = none.

call_window_startstringDefaults to 08:00

Earliest permitted outbound call time (HH:MM, 24hr). CBN compliance.

call_window_endstringDefaults to 20:00

Latest permitted outbound call time (HH:MM, 24hr). CBN compliance.

call_window_timezonestringDefaults to Africa/Lagos
IANA timezone for call window evaluation.
pre_call_announcementstring

CBN requirement: spoken announcement at start of call identifying the sponsoring institution.

recording_enabledboolean

Whether call recording is enabled for this agent. Workspace-level recording must also be enabled via POST /v1/workspace/recording for calls to be recorded.

consent_requiredboolean

When true (default), the caller hears a consent prompt before recording starts. When false, recording begins immediately. Only disable if you have an independent legal basis under NDPR.

screening_enabledboolean

BYOM only. When true, inbound calls trigger a synchronous call.screening webhook (to the agent’s webhook_url) BEFORE the greeting so you can allow/reject the caller and optionally override the greeting. See the BYOM guide.

screening_fail_closedboolean

Screening failure policy. false (default) = fail-open (allow the call if the screening webhook errors/times out); true = fail-closed (reject).

statusenum
created_atdatetime
updated_atdatetime

Errors

404
Get Agent Request Not Found Error