Get an agent | Voicebip | Documentation

{
  "agent_id": "agent_id",
  "workspace_id": "workspace_id",
  "display_name": "display_name",
  "description": "description",
  "language": "language",
  "ai_provider": "ai_provider",
  "ai_model": "ai_model",
  "tts_voice": "tts_voice",
  "system_prompt": "system_prompt",
  "webhook_url": "webhook_url",
  "greeting_text": "greeting_text",
  "greeting_audio_url": "greeting_audio_url",
  "tool_definitions": "[{\"type\":\"function\",\"function\":{\"name\":\"hang_up\",\"description\":\"End the call gracefully\",\"parameters\":{\"type\":\"object\",\"properties\":{},\"required\":[]}}}]",
  "shareable": true,
  "knowledge_base_id": "knowledge_base_id",
  "call_window_start": "08:00",
  "call_window_end": "20:00",
  "call_window_timezone": "Africa/Lagos",
  "pre_call_announcement": "pre_call_announcement",
  "recording_enabled": true,
  "consent_required": true,
  "screening_enabled": true,
  "screening_fail_closed": true,
  "status": "active",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z"
}

Authentication

AuthorizationBearer

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

Path parameters

agent_idstringRequired

Response

Agent details

agent_idstringOptional

workspace_idstringOptional

display_namestringOptional

descriptionstringOptional

languagestringOptional

ai_providerstringOptional

ai_modelstringOptional

tts_voicestringOptional

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_promptstringOptional

webhook_urlstringOptional

greeting_textstringOptional

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

greeting_audio_urlstringOptional

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_definitionsstringOptionalDefaults 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 ”[]”.

shareablebooleanOptional

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

knowledge_base_idstringOptional

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

call_window_startstringOptionalDefaults to 08:00

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

call_window_endstringOptionalDefaults to 20:00

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

call_window_timezonestringOptionalDefaults to Africa/Lagos

IANA timezone for call window evaluation.

pre_call_announcementstringOptional

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

recording_enabledbooleanOptional

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_requiredbooleanOptional

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_enabledbooleanOptional

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_closedbooleanOptional

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

statusenumOptional

created_atdatetimeOptional

updated_atdatetimeOptional

Errors

404

Get Agent Request Not Found Error