List Agents

GET

https://api.speechify.ai/v1/agents

GET

/v1/agents

$ curl https://api.speechify.ai/v1/agents \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "agents": [
3     {
4       "id": "agent_01kxmwcejz05xht5gmej146s6j",
5       "name": "Acme Support Bot",
6       "slug": "acme-support-bot",
7       "prompt": "You are a helpful assistant for Acme Inc customer support.",
8       "first_message": "Hello! How can I assist you with Acme Inc today?",
9       "language": "en",
10       "llm_provider": "openai",
11       "llm_model": "gpt-4",
12       "voice_id": "en_us_male_01",
13       "temperature": 0.7,
14       "is_public": false,
15       "allowed_origins": [],
16       "memory_enabled": true,
17       "memory_retention_days": 90,
18       "amd": {
19         "enabled": true,
20         "on_voicemail": {
21           "action": "leave_message",
22           "message": "Hi, this is Acme Inc. Please call us back at your convenience."
23         },
24         "on_ivr": {
25           "action": "proceed"
26         },
27         "on_unavailable": {
28           "action": "hangup"
29         },
30         "tuning": {
31           "human_speech_threshold_seconds": 2,
32           "no_speech_threshold_seconds": 5,
33           "timeout_seconds": 20,
34           "classification_prompt": "Detect if the call is answered by a human, voicemail, or machine."
35         }
36       },
37       "save_audio_recording": false,
38       "navigator_mode": false,
39       "ivr_memory_enabled": true,
40       "created_at": "2024-01-15T09:30:00Z",
41       "updated_at": "2024-04-10T14:45:00Z",
42       "llm_base_url": null,
43       "llm_api_key_set": false,
44       "llm_extra_body": null,
45       "widget_config": {
46         "version": 2,
47         "style": "pill",
48         "theme": "light",
49         "avatar": {
50           "type": "orb",
51           "image_url": "",
52           "orb_color_1": "#4A90E2",
53           "orb_color_2": "#50E3C2"
54         },
55         "text": {
56           "start_call": "Starting your call now.",
57           "end_call": "Thank you for calling Acme Inc!",
58           "listening": "I'm listening...",
59           "thinking": "Let me think about that...",
60           "speaking": "Here's what I found:"
61         },
62         "terms": {
63           "enabled": true,
64           "content": "By using this service, you agree to Acme Inc's terms and conditions."
65         },
66         "transcript": {
67           "enabled": true
68         }
69       },
70       "hostname_allowlist": null,
71       "webhook_url": "https://webhooks.acme.com/call-complete",
72       "webhook_secret_set": true,
73       "tts_speaking_rate": 1,
74       "tts_playback_rate": 1,
75       "response_delay_seconds": 0.5,
76       "inactivity_timeout_seconds": 300,
77       "background_noise_preset": "office",
78       "background_noise_volume": 0.3,
79       "stt_override": "whisper-v3"
80     }
81   ]
82 }

List voice agents owned by the caller.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Response

A list of voice agents.

agentslist of objects

Errors

401

Unauthorized Error