List Agents

GET

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

GET

/v1/agents

1 import { AgentPhoneClient } from "agentphone";
2 
3 async function main() {
4     const client = new AgentPhoneClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.agents.listAgents({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5       "name": "Support Agent Alpha",
6       "description": "Handles customer support inquiries for product issues.",
7       "voiceMode": "hosted",
8       "voice": "en-US-Wavenet-D",
9       "createdAt": "2024-01-15T09:30:00Z",
10       "enableMessaging": true,
11       "modelTier": "balanced",
12       "systemPrompt": "You are a helpful customer support agent.",
13       "beginMessage": "Hello! How can I assist you today?",
14       "transferNumber": "+14155552671",
15       "customTools": [
16         {
17           "toolName": "FAQ Lookup",
18           "enabled": true
19         }
20       ],
21       "voicemailMessage": "Sorry we missed your call. Please leave a message.",
22       "callScreeningIdentity": "Support Team",
23       "callScreeningPurpose": "Verify caller intent before connecting.",
24       "sttMode": "fast",
25       "ambientSound": "office",
26       "denoisingMode": "noise-cancellation",
27       "maxSilenceMs": 600000,
28       "voiceSpeed": 1,
29       "interruptionSensitivity": 0.8,
30       "enableBackchannel": true,
31       "language": "en-US",
32       "numbers": [
33         {
34           "id": "num-1234abcd",
35           "phoneNumber": "+14155551234",
36           "status": "active",
37           "type": "sms"
38         }
39       ]
40     }
41   ],
42   "total": 1
43 }

List all agents for this account.

Authentication

AuthorizationBearer

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

Query parameters

offsetintegerOptional>=0Defaults to 0

Response

Successful Response

datalist of objects

totalinteger

Errors

422

Unprocessable Entity Error

Authentication

Headers

Query parameters

Response

Errors