List

GET

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

GET

/v1/tools

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.tools.list(
9     project="main"
10 )

Try it

200Retrieved

1 {
2   "tools": [
3     {
4       "id": "tool_29874283-c829-abf9-3028-309bc7aw3098",
5       "name": "context_printer",
6       "description": "Gets the specific context for fixing our printer",
7       "project": {
8         "id": "proj_8e5bdac5-868d-46fa-b300-439e777f7bfd",
9         "name": "main"
10       },
11       "type": "custom_context",
12       "execution_mode": "sync",
13       "parameters": [],
14       "require_speech_before_tool_call": false,
15       "forbid_speech_after_tool_call": false,
16       "allow_tool_chaining": true,
17       "context": "Press the A button 5 times then gently shake the printer."
18     },
19     {
20       "id": "tool_12cf6e88-c254-4d3e-a149-ddf1bdd2254c",
21       "name": "book_appointment",
22       "description": "Books an appointment in the calendar system",
23       "project": {
24         "id": "proj_8e5bdac5-868d-46fa-b300-439e777f7bfd",
25         "name": "main"
26       },
27       "type": "custom_webhook",
28       "execution_mode": "sync",
29       "parameters": [
30         {
31           "type": "string",
32           "name": "date",
33           "description": "The date for the appointment in YYYY-MM-DD format",
34           "is_required": true,
35           "location": "request_body"
36         },
37         {
38           "type": "string",
39           "name": "time",
40           "description": "The time for the appointment in HH:MM format",
41           "is_required": true,
42           "location": "request_body"
43         }
44       ],
45       "endpoint_method": "POST",
46       "endpoint_url": "https://api.example.com/book-appointment",
47       "endpoint_headers": {
48         "Authorization": "Bearer token123",
49         "Content-Type": "application/json"
50       },
51       "endpoint_timeout_ms": 5000,
52       "require_speech_before_tool_call": false,
53       "wait_for_speech_before_tool_call": false,
54       "forbid_speech_after_tool_call": false,
55       "allow_tool_chaining": true
56     },
57     {
58       "id": "tool_98765432-abcd-efgh-ijkl-mnopqrstuvwx",
59       "name": "get_product_recommendations",
60       "description": "Gets personalized product recommendations",
61       "project": {
62         "id": "proj_8e5bdac5-868d-46fa-b300-439e777f7bfd",
63         "name": "main"
64       },
65       "type": "custom_websocket",
66       "execution_mode": "async",
67       "parameters": [
68         {
69           "type": "string",
70           "name": "category",
71           "description": "Product category (e.g., 'handbags', 'shoes', 'electronics')",
72           "is_required": true
73         }
74       ],
75       "tool_call_output_timeout_ms": 5000,
76       "require_speech_before_tool_call": false,
77       "wait_for_speech_before_tool_call": false,
78       "forbid_speech_after_tool_call": false,
79       "allow_tool_chaining": true,
80       "wait_for_response": false
81     },
82     {
83       "id": "tool_11111111-2222-3333-4444-555555555555",
84       "name": "transfer_to_support",
85       "description": "Transfers the caller to the support team",
86       "project": {
87         "id": "proj_8e5bdac5-868d-46fa-b300-439e777f7bfd",
88         "name": "main"
89       },
90       "type": "built_in_transfer_to_phone_number",
91       "execution_mode": "sync",
92       "parameters": [],
93       "phone_number": "+15551234567",
94       "dtmf": "1234",
95       "use_agent_phone_number": true,
96       "detect_voicemail": false,
97       "require_speech_before_tool_call": false
98     },
99     {
100       "id": "tool_22222222-3333-4444-5555-666666666666",
101       "name": "transfer_to_specialist",
102       "description": "Transfers the caller to a specialist agent",
103       "project": {
104         "id": "proj_8e5bdac5-868d-46fa-b300-439e777f7bfd",
105         "name": "main"
106       },
107       "type": "built_in_transfer_to_agent",
108       "execution_mode": "sync",
109       "parameters": [],
110       "agents_to_transfer_to": [
111         "sales-agent",
112         "support-agent",
113         "technical-agent"
114       ],
115       "require_speech_before_tool_call": false
116     }
117   ]
118 }

Returns all custom tools for the organization.

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 tools for.

Response

Success response

toolslist of objects

Authentication

Query parameters

Response

Errors