Introduction
Agents
Knowledge Base
Copy
{
"config": {
"tool_name": "GetOrderStatus",
"tool_description": "Retrieves the status of a customer order using their order ID",
"webhook_url": "https://api.shop.com/orders/status",
"http_method": "POST",
"parameters": [
{
"parameter_name": "order_id",
"parameter_type": "string",
"parameter_description": "The unique order identifier",
"parameter_required": true
}
]
}
}
Copy
{
"success": true,
"tool": {}
}Tools
Create Tool
POST
/
api
/
tools
Copy
{
"config": {
"tool_name": "GetOrderStatus",
"tool_description": "Retrieves the status of a customer order using their order ID",
"webhook_url": "https://api.shop.com/orders/status",
"http_method": "POST",
"parameters": [
{
"parameter_name": "order_id",
"parameter_type": "string",
"parameter_description": "The unique order identifier",
"parameter_required": true
}
]
}
}
Copy
{
"success": true,
"tool": {}
}Create a new custom tool that agents can use during calls.
Tool configuration object.
Show config properties
Show config properties
Name of the tool (must be unique within your organization).
Natural language description of what the tool does. The LLM uses this to decide when to call the tool.
The API endpoint URL that Butter AI will call.
HTTP method (
GET, POST, PUT, DELETE).Maximum time to wait for your API to respond.
Key-value pairs of HTTP headers to include in the request (e.g.,
{"Authorization": "Bearer ..."}).List of parameters the tool accepts.
Show ToolParameter properties
Show ToolParameter properties
The name of the parameter.
The data type (e.g.,
string, integer, boolean).Description used by the LLM to extract this value from the conversation.
Whether this parameter is mandatory for the tool call.
Response
Indicates success.
The created tool object.
Copy
{
"config": {
"tool_name": "GetOrderStatus",
"tool_description": "Retrieves the status of a customer order using their order ID",
"webhook_url": "https://api.shop.com/orders/status",
"http_method": "POST",
"parameters": [
{
"parameter_name": "order_id",
"parameter_type": "string",
"parameter_description": "The unique order identifier",
"parameter_required": true
}
]
}
}
⌘I