List Agents

GET

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

GET

/v1/agents

1 const url = 'https://api.agentphone.ai/v1/agents';
2 const options = {
3   method: 'GET',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "data": [
3     {
4       "id": "agent_9f8b7c6d5e4f3a2b1c0d",
5       "name": "Customer Support AI",
6       "description": "Handles inbound customer support calls and queries.",
7       "voiceMode": "hosted",
8       "voice": "en-US-Wavenet-D",
9       "createdAt": "2024-01-15T09:30:00Z",
10       "enableMessaging": true,
11       "modelTier": "turbo",
12       "systemPrompt": "You are a helpful customer support assistant.",
13       "beginMessage": "Hello! How can I assist you today?",
14       "transferNumber": "+14155551234",
15       "voicemailMessage": "Sorry we missed your call. Please leave a message.",
16       "sttMode": "accurate",
17       "ambientSound": "office",
18       "denoisingMode": "noise-and-background-speech-cancellation",
19       "maxSilenceMs": 300000,
20       "voiceSpeed": 1.1,
21       "interruptionSensitivity": 0.7,
22       "enableBackchannel": true,
23       "language": "en-US",
24       "numbers": [
25         {
26           "id": "num_123abc456def7890",
27           "phoneNumber": "+14155559876",
28           "status": "active",
29           "type": "sms"
30         }
31       ]
32     }
33   ],
34   "total": 1
35 }

List all agents for this account.

List Agents

List Agents

Authentication

Query parameters

Response

Errors

Authentication

Query parameters

Response

Errors

1	const url = 'https://api.agentphone.ai/v1/agents';
2	const options = {
3	method: 'GET',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"data": [
3	{
4	"id": "agent_9f8b7c6d5e4f3a2b1c0d",
5	"name": "Customer Support AI",
6	"description": "Handles inbound customer support calls and queries.",
7	"voiceMode": "hosted",
8	"voice": "en-US-Wavenet-D",
9	"createdAt": "2024-01-15T09:30:00Z",
10	"enableMessaging": true,
11	"modelTier": "turbo",
12	"systemPrompt": "You are a helpful customer support assistant.",
13	"beginMessage": "Hello! How can I assist you today?",
14	"transferNumber": "+14155551234",
15	"voicemailMessage": "Sorry we missed your call. Please leave a message.",
16	"sttMode": "accurate",
17	"ambientSound": "office",
18	"denoisingMode": "noise-and-background-speech-cancellation",
19	"maxSilenceMs": 300000,
20	"voiceSpeed": 1.1,
21	"interruptionSensitivity": 0.7,
22	"enableBackchannel": true,
23	"language": "en-US",
24	"numbers": [
25	{
26	"id": "num_123abc456def7890",
27	"phoneNumber": "+14155559876",
28	"status": "active",
29	"type": "sms"
30	}
31	]
32	}
33	],
34	"total": 1
35	}