API Reference
API Documentation
V3
- Get Started
- π Workspaces
- π€ Agents
- Calls & Numbers
- π¨ Tools
- βοΈ Variables
- π₯ Leads
- π§ Knowledge Base
- π¬ Conversations
- π’ Orgs
Agents
- Introduction
- GETGet Agent
- POSTCreate/Edit Agent
- DELDelete Agent
- POSTChat Interact
- POSTConfigure State
- π§ Knowledge Base
- π¬ Conversations
- π Analytics
Workspaces
- GETGet Workspace
- POSTEdit Workspace
- DELDelete Workspace
- πΌ Agency
- π’ Orgs
- π€ Clients
π¨ Tools
Create Tool
Creates a new tool, this route must use the new V3 endpoints.
POST
/
agents
/
{agentId}
/
tools
Copy
curl --request POST \
--url https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/tools \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"tool": {
"isDefault": true,
"method": "GET",
"name": "<string>",
"description": "<string>",
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"disabled": true,
"isVapiTool": true,
"vapiId": "<string>",
"isGlobal": true,
"fields": [
{
"id": "<string>",
"in": "<string>",
"type": "string",
"value": "<any>",
"defaultValue": "<any>",
"key": "<string>",
"description": "<string>",
"required": true,
"reusable": true,
"isEnv": true,
"isSystem": true,
"isGlobal": true,
"agentId": "<string>",
"userId": "<string>"
}
],
"channels": [
"web-chat"
]
}
}'
Copy
{
"success": true,
"message": "<string>",
"data": {
"isDefault": true,
"method": "GET",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"disabled": true,
"isVapiTool": true,
"vapiId": "<string>",
"isGlobal": true,
"variablesIds": [
"<string>"
],
"agentId": "<string>",
"userId": "<string>",
"backchannellingPhrases": [
"<string>"
],
"fields": [
{
"id": "<string>",
"in": "<string>",
"type": "string",
"value": "<any>",
"defaultValue": "<any>",
"key": "<string>",
"description": "<string>",
"required": true,
"reusable": true,
"isEnv": true,
"isSystem": true,
"isGlobal": true,
"agentId": "<string>",
"userId": "<string>"
}
],
"channels": [
"web-chat"
]
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
application/json
Response
200
application/json
Successful response
The response is of type object
.
The response is of type object
.
The response is of type any
.
Copy
curl --request POST \
--url https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/tools \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"tool": {
"isDefault": true,
"method": "GET",
"name": "<string>",
"description": "<string>",
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"disabled": true,
"isVapiTool": true,
"vapiId": "<string>",
"isGlobal": true,
"fields": [
{
"id": "<string>",
"in": "<string>",
"type": "string",
"value": "<any>",
"defaultValue": "<any>",
"key": "<string>",
"description": "<string>",
"required": true,
"reusable": true,
"isEnv": true,
"isSystem": true,
"isGlobal": true,
"agentId": "<string>",
"userId": "<string>"
}
],
"channels": [
"web-chat"
]
}
}'
Copy
{
"success": true,
"message": "<string>",
"data": {
"isDefault": true,
"method": "GET",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"serverUrl": "<string>",
"serverUrlSecret": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"disabled": true,
"isVapiTool": true,
"vapiId": "<string>",
"isGlobal": true,
"variablesIds": [
"<string>"
],
"agentId": "<string>",
"userId": "<string>",
"backchannellingPhrases": [
"<string>"
],
"fields": [
{
"id": "<string>",
"in": "<string>",
"type": "string",
"value": "<any>",
"defaultValue": "<any>",
"key": "<string>",
"description": "<string>",
"required": true,
"reusable": true,
"isEnv": true,
"isSystem": true,
"isGlobal": true,
"agentId": "<string>",
"userId": "<string>"
}
],
"channels": [
"web-chat"
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.