List

GET

https://api.phonic.co/v1/agents

GET

/v1/agents

1 from phonic import Phonic
2 
3 client = Phonic(
4     base_url="https://api.phonic.co/v1",
5     api_key="YOUR_TOKEN_HERE"
6 )
7 
8 client.agents.list()

Try it

200Retrieved

1 {
2   "agents": [
3     {
4       "id": "agent_12cf6e88-c254-4d3e-a149-a7f1bdd22783",
5       "name": "support-agent",
6       "phone_numbers": [
7         "string"
8       ],
9       "project": {
10         "id": "proj_ad0334f1-2487-4155-9df3-abd8129b29ad",
11         "name": "customer-support"
12       },
13       "timezone": "America/Los_Angeles",
14       "voice_id": "grant",
15       "audio_format": "pcm_44100",
16       "audio_speed": 1,
17       "background_noise_level": 0,
18       "background_noise": null,
19       "generate_welcome_message": false,
20       "welcome_message": "Hi {{customer_name}}. How can I help you today?",
21       "system_prompt": "You are an expert in {{subject}}. Be friendly, helpful and concise.",
22       "template_variables": {
23         "customer_name": {
24           "default_value": "Sean"
25         },
26         "subject": {
27           "default_value": "Chess"
28         }
29       },
30       "tools": [
31         "keypad_input"
32       ],
33       "tasks": [
34         {
35           "name": "Check Availability",
36           "description": "Check if the appointment is available"
37         },
38         {
39           "name": "Book Appointment",
40           "description": "Book the appointment"
41         }
42       ],
43       "no_input_poke_sec": 30,
44       "no_input_poke_text": "Are you still there?",
45       "no_input_end_conversation_sec": 180,
46       "languages": [
47         "en",
48         "es"
49       ],
50       "boosted_keywords": [
51         "Load ID",
52         "dispatch"
53       ],
54       "configuration_endpoint": {
55         "url": "https://api.example.com/config",
56         "headers": {
57           "Authorization": "Bearer token123"
58         },
59         "timeout_ms": 7000
60       },
61       "phone_number": "+1234567890"
62     }
63   ]
64 }

Returns all agents in a project.

Authentication

AuthorizationBearer

Bearer authentication header of the form Bearer <PHONIC_API_KEY>. Manage your API keys here.

Bearer authentication header of the form `Bearer <PHONIC_API_KEY>`. Manage your API keys [here](https://phonic.co/api-keys).

Query parameters

projectstringOptionalDefaults to main

The name of the project to list agents for.

Response

Success response

agentslist of objects

Authentication

Query parameters

Response

Errors