Get Tool

GET

Path parameters

idstringRequired

Headers

Auth

AuthorizationstringRequired

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

Response

Dtmf

End Call

Function

Ghl

Make

Transfer Call

Output

GET

1 curl https://api.vapi.ai/tool/id \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "type": "output",
3   "createdAt": "2024-01-15T09:30:00Z",
4   "id": "string",
5   "orgId": "string",
6   "updatedAt": "2024-01-15T09:30:00Z",
7   "async": false,
8   "function": {
9     "name": "name",
10     "strict": true,
11     "description": "description",
12     "parameters": {
13       "type": "object",
14       "properties": {
15         "key": {
16           "type": "string"
17         }
18       },
19       "required": [
20         "required"
21       ]
22     }
23   },
24   "messages": [
25     {
26       "type": "request-response-delayed",
27       "conditions": [
28         {
29           "operator": "eq",
30           "param": "param",
31           "value": {
32             "key": "value"
33           }
34         }
35       ],
36       "content": "string",
37       "contents": [
38         {
39           "type": "text",
40           "text": "text",
41           "language": "aa"
42         }
43       ],
44       "timingMilliseconds": 1000
45     }
46   ],
47   "server": {
48     "url": "url",
49     "timeoutSeconds": 20,
50     "secret": "secret",
51     "headers": {
52       "key": "value"
53     }
54   }
55 }

Delete Tool

Up Next

Built with

1	curl https://api.vapi.ai/tool/id \
2	-H "Authorization: Bearer <token>"

1	{
2	"type": "output",
3	"createdAt": "2024-01-15T09:30:00Z",
4	"id": "string",
5	"orgId": "string",
6	"updatedAt": "2024-01-15T09:30:00Z",
7	"async": false,
8	"function": {
9	"name": "name",
10	"strict": true,
11	"description": "description",
12	"parameters": {
13	"type": "object",
14	"properties": {
15	"key": {
16	"type": "string"
17	}
18	},
19	"required": [
20	"required"
21	]
22	}
23	},
24	"messages": [
25	{
26	"type": "request-response-delayed",
27	"conditions": [
28	{
29	"operator": "eq",
30	"param": "param",
31	"value": {
32	"key": "value"
33	}
34	}
35	],
36	"content": "string",
37	"contents": [
38	{
39	"type": "text",
40	"text": "text",
41	"language": "aa"
42	}
43	],
44	"timingMilliseconds": 1000
45	}
46	],
47	"server": {
48	"url": "url",
49	"timeoutSeconds": 20,
50	"secret": "secret",
51	"headers": {
52	"key": "value"
53	}
54	}
55	}