API Reference
API Documentation
V3
- Get Started
- 📁 Workspaces
- 🤖 Agents
- Calls & Numbers
- 🔨 Tools
- ✖️ Variables
- 👥 Leads
- 🧠 Knowledge Base
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
Create Tool
Creates a new tool, this route must use the new V3 endpoints.
curl --request POST \
--url https://eu-voiceglow-runtime-vbmbkqccuq-ey.a.run.app/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"
]
}
}'{
"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
The name of the tool, providing a human-readable identifier for display purposes.
A detailed description of the tool's purpose and functionality. Helps users understand its role within the agent.
Indicates whether this tool is the default tool for the agent. Defaults to false if unspecified.
The HTTP method used by this tool. Acceptable values are 'GET', 'POST', 'PUT', or 'PATCH'. Defaults to 'POST' if unspecified.
GET, POST, PUT, PATCH The server URL where the tool's operations are performed. Used for network-based integrations.
A secret token or key associated with the server URL. Provides secure access to the tool's backend services.
Indicates whether the tool is currently disabled. A disabled tool cannot be used by the agent.
Indicates whether the tool is a Virtual API (VAPI) tool. VAPI tools enable interaction with external APIs.
A unique identifier for the VAPI associated with this tool. Used for integration with specific API endpoints.
If true, this tool is globally accessible to all nodes and agents. Overrides context-specific restrictions.
A unique identifier for the field, ensuring it is distinct across the system.
Defines the location or context in which the field is utilized. Common values include 'query', 'body', or 'header'.
Specifies the variable type of the field. Acceptable values include 'string', 'number', 'boolean', and 'system'.
string, number, boolean, system The current assigned value of the field. This value is optional and supports any type depending on the field's context.
A predefined value assigned to the field when no specific value is provided. Useful for ensuring consistent behavior.
The unique key that identifies this tool field or variable. Often used for referencing the field programmatically.
A detailed explanation of the field's purpose and usage. Helps users understand the field's role in the system.
Indicates whether the presence of this field is mandatory for successful operation. Defaults to false if unspecified.
Denotes whether this field can be reused across multiple contexts or tools. Useful for reducing redundancy.
Specifies if this field represents an environment variable, typically used for configuration or deployment.
Indicates whether this field is a system-level variable, reserved for core operations or internal use.
If enabled, this field remains globally accessible to the agent across all operational contexts. Useful for global constants.
References the unique identifier of the agent associated with this field. Helps in mapping fields to specific agents.
References the unique identifier of the user associated with this field. Useful for user-specific customizations.
The channels that the tool can be used on.
web-chat, whatsapp, instagram, telegram, discord, gb-chat, vapi, messenger, voice, telephony Response
A unique identifier for the tool. Ensures distinct identification within the system.
The name of the tool, providing a human-readable identifier for display purposes.
A detailed description of the tool's purpose and functionality. Helps users understand its role within the agent.
Indicates whether this tool is the default tool for the agent. Defaults to false if unspecified.
The HTTP method used by this tool. Acceptable values are 'GET', 'POST', 'PUT', or 'PATCH'. Defaults to 'POST' if unspecified.
GET, POST, PUT, PATCH The server URL where the tool's operations are performed. Used for network-based integrations.
A secret token or key associated with the server URL. Provides secure access to the tool's backend services.
The timestamp when the tool was created, formatted as an ISO 8601 string. Useful for tracking tool lifecycle.
The timestamp when the tool was last updated, formatted as an ISO 8601 string. Useful for versioning and auditing.
Indicates whether the tool is currently disabled. A disabled tool cannot be used by the agent.
Indicates whether the tool is a Virtual API (VAPI) tool. VAPI tools enable interaction with external APIs.
A unique identifier for the VAPI associated with this tool. Used for integration with specific API endpoints.
If true, this tool is globally accessible to all nodes and agents. Overrides context-specific restrictions.
An array of variable IDs associated with the tool. Each ID maps to a specific variable used by the tool.
The unique identifier of the agent associated with this tool. Helps in linking the tool to a specific agent.
The unique identifier of the user associated with this tool. Used for user-specific configurations and access control.
An array of phrases used for backchannel communication. These phrases help in maintaining conversational flow.
A unique identifier for the field, ensuring it is distinct across the system.
Defines the location or context in which the field is utilized. Common values include 'query', 'body', or 'header'.
Specifies the variable type of the field. Acceptable values include 'string', 'number', 'boolean', and 'system'.
string, number, boolean, system The current assigned value of the field. This value is optional and supports any type depending on the field's context.
A predefined value assigned to the field when no specific value is provided. Useful for ensuring consistent behavior.
The unique key that identifies this tool field or variable. Often used for referencing the field programmatically.
A detailed explanation of the field's purpose and usage. Helps users understand the field's role in the system.
Indicates whether the presence of this field is mandatory for successful operation. Defaults to false if unspecified.
Denotes whether this field can be reused across multiple contexts or tools. Useful for reducing redundancy.
Specifies if this field represents an environment variable, typically used for configuration or deployment.
Indicates whether this field is a system-level variable, reserved for core operations or internal use.
If enabled, this field remains globally accessible to the agent across all operational contexts. Useful for global constants.
References the unique identifier of the agent associated with this field. Helps in mapping fields to specific agents.
References the unique identifier of the user associated with this field. Useful for user-specific customizations.
The channels that the tool can be used on.
web-chat, whatsapp, instagram, telegram, discord, gb-chat, vapi, messenger, voice, telephony curl --request POST \
--url https://eu-voiceglow-runtime-vbmbkqccuq-ey.a.run.app/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"
]
}
}'{
"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"
]
}
}