Tools
Create Tool
POST
/
tool
curl --request POST \
--url https://api.vapi.ai/tool \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"async": false,
"messages": [
{
"type": "request-start",
"content": "<string>",
"conditions": [
{
"value": "<string>",
"operator": "eq",
"param": "<string>"
}
]
}
],
"type": "dtmf",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
},
"server": {
"timeoutSeconds": 20,
"url": "<string>",
"secret": "<string>"
}
}'
{
"async": false,
"messages": [
{
"type": "request-start",
"content": "<string>",
"conditions": [
{
"value": "<string>",
"operator": "eq",
"param": "<string>"
}
]
}
],
"type": "dtmf",
"id": "<string>",
"orgId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
},
"server": {
"timeoutSeconds": 20,
"url": "<string>",
"secret": "<string>"
}
}
Body
application/json
Response
201 - application/json
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.vapi.ai/tool \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"async": false,
"messages": [
{
"type": "request-start",
"content": "<string>",
"conditions": [
{
"value": "<string>",
"operator": "eq",
"param": "<string>"
}
]
}
],
"type": "dtmf",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
},
"server": {
"timeoutSeconds": 20,
"url": "<string>",
"secret": "<string>"
}
}'
{
"async": false,
"messages": [
{
"type": "request-start",
"content": "<string>",
"conditions": [
{
"value": "<string>",
"operator": "eq",
"param": "<string>"
}
]
}
],
"type": "dtmf",
"id": "<string>",
"orgId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
}
},
"server": {
"timeoutSeconds": 20,
"url": "<string>",
"secret": "<string>"
}
}
Assistant
Responses are generated using AI and may contain mistakes.