Get a tool definition
{
"data": {
"id": "645e9e4acc61621ce9521a89",
"name": "get_order_status",
"description": "Fetch an order status using an orderId.",
"parameters": {
"type": "object",
"properties": {
"orderId": {
"type": "string"
}
},
"required": [
"orderId"
]
},
"endpoint": {
"url": "https://api.client.com/tools/get-order-status",
"method": "POST",
"timeoutMs": 10000
},
"auth": {
"type": "bearer",
"token": "REDACTED"
},
"createdAt": "2025-11-27T16:00:00.000Z",
"updatedAt": "2025-11-27T16:00:00.000Z",
"active": true
}
}Path Parameters
Response
Tool definition fetched successfully
Show child attributes
Show child attributes
"645e9e4acc61621ce9521a89"
Tool function name. Must be unique.
1 - 64"get_order_status"
What this tool does. This is shown to the LLM to help it decide when to call the tool.
1 - 500"Fetch an order status using an orderId."
JSON Schema object describing the tool function parameters.
Show child attributes
Show child attributes
object {
"type": "object",
"properties": { "orderId": { "type": "string" } },
"required": ["orderId"]
}Invocation settings for the tool endpoint.
Show child attributes
Show child attributes
HTTPS endpoint that Visito will call when this tool is invoked.
"https://api.client.com/tools/get-order-status"
HTTP method used to invoke the tool.
GET, POST "POST"
Request timeout in milliseconds. Defaults to 10 seconds if not provided.
100 <= x <= 3000010000
{
"url": "https://api.client.com/tools/get-order-status",
"method": "POST",
"timeoutMs": 10000
}When the tool was created (ISO 8601)
"2025-11-27T16:00:00.000Z"
When the tool was last updated (ISO 8601)
"2025-11-27T16:00:00.000Z"
Whether this tool is enabled and can be used by the agent.
true
{
"data": {
"id": "645e9e4acc61621ce9521a89",
"name": "get_order_status",
"description": "Fetch an order status using an orderId.",
"parameters": {
"type": "object",
"properties": {
"orderId": {
"type": "string"
}
},
"required": [
"orderId"
]
},
"endpoint": {
"url": "https://api.client.com/tools/get-order-status",
"method": "POST",
"timeoutMs": 10000
},
"auth": {
"type": "bearer",
"token": "REDACTED"
},
"createdAt": "2025-11-27T16:00:00.000Z",
"updatedAt": "2025-11-27T16:00:00.000Z",
"active": true
}
}