List agents

GET

/v1/agents

GET

/v1/agents

$ curl https://api.voicebip.com/v1/agents \
>      -H "Authorization: Bearer <token>"

1 {
2   "agents": [
3     {
4       "agent_id": "agent_id",
5       "workspace_id": "workspace_id",
6       "display_name": "display_name",
7       "description": "description",
8       "language": "language",
9       "ai_provider": "ai_provider",
10       "ai_model": "ai_model",
11       "tts_voice": "tts_voice",
12       "system_prompt": "system_prompt",
13       "webhook_url": "webhook_url",
14       "greeting_text": "greeting_text",
15       "greeting_audio_url": "greeting_audio_url",
16       "tool_definitions": "[{\"type\":\"function\",\"function\":{\"name\":\"hang_up\",\"description\":\"End the call gracefully\",\"parameters\":{\"type\":\"object\",\"properties\":{},\"required\":[]}}}]",
17       "shareable": true,
18       "knowledge_base_id": "knowledge_base_id",
19       "call_window_start": "08:00",
20       "call_window_end": "20:00",
21       "call_window_timezone": "Africa/Lagos",
22       "pre_call_announcement": "pre_call_announcement",
23       "recording_enabled": true,
24       "consent_required": true,
25       "screening_enabled": true,
26       "screening_fail_closed": true,
27       "status": "active",
28       "created_at": "2024-01-15T09:30:00Z",
29       "updated_at": "2024-01-15T09:30:00Z"
30     }
31   ],
32   "next_page_token": "next_page_token"
33 }

Authentication

AuthorizationBearer

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

Query parameters

page_sizeintegerOptional

page_tokenstringOptional

Response

Agent list

agentslist of objects

next_page_tokenstring

Errors

401

List Agents Request Unauthorized Error