Introduction
Agent API
Agent Tool API
Widget Settings API
Phone Number & Telephony API
- GETList Available Numbers
- POSTBuy Phone Number
- DELRelease Phone Number
- GETList Purchased Numbers
- POSTImport Phone Number
- GETList Imported Numbers
- GETGet Imported Number
- PUTUpdate Imported Number
- DELDelete Imported Number
- GETList Twilio Owned Numbers
- POSTAdd Twilio Number
- POSTCreate Telephony Type
- GETGet Selected Telephony
Campaign API
Contact API
Appointment API
Cal.com Integration API
RAG Knowledge Base API
Webhooks
Health API
curl https://api.ravan.ai/api/v1/tools/019d1fdb-3977-7bd5-ab27-8d3b37ddf4fc/ \
-H "X-Api-Key: YOUR_API_KEY"
{
"success": true,
"message": "Tool fetched successfully",
"data": {
"id": "019d1fdb-3977-7bd5-ab27-8d3b37ddf4fc",
"organizationId": "1268c1f0-19f3-47db-aefb-c16a7c3ace6e",
"name": "check_order_status",
"description": "Look up the current status of a customer order by order ID",
"type": "function",
"definition": {
"name": "check_order_status",
"description": "Look up the current status of a customer order",
"parameters": {
"type": "object",
"properties": {
"order_id": {
"type": "string",
"description": "The unique order identifier"
}
},
"required": ["order_id"]
}
},
"isActive": true
}
}
Agent Tool API
Get Agent Tool
Retrieve the full definition and status of a single agent tool by its ID.
GET
/
api
/
v1
/
tools
/
{id}
curl https://api.ravan.ai/api/v1/tools/019d1fdb-3977-7bd5-ab27-8d3b37ddf4fc/ \
-H "X-Api-Key: YOUR_API_KEY"
{
"success": true,
"message": "Tool fetched successfully",
"data": {
"id": "019d1fdb-3977-7bd5-ab27-8d3b37ddf4fc",
"organizationId": "1268c1f0-19f3-47db-aefb-c16a7c3ace6e",
"name": "check_order_status",
"description": "Look up the current status of a customer order by order ID",
"type": "function",
"definition": {
"name": "check_order_status",
"description": "Look up the current status of a customer order",
"parameters": {
"type": "object",
"properties": {
"order_id": {
"type": "string",
"description": "The unique order identifier"
}
},
"required": ["order_id"]
}
},
"isActive": true
}
}
Authorizations
Your Agni API key. Find it in your support@ravan.ai under Settings → API Keys.
Path Parameters
The unique UUID of the tool to retrieve.
Response
Whether the request succeeded.
Human-readable status message.
The tool object.
Show data
Show data
Unique tool ID (UUID).
ID of the organization that owns this tool.
Tool name (lowercase, underscores, no spaces).
Human-readable description shown to the LLM.
Tool type — e.g.
function, webhook.JSON Schema definition including parameter schema.
Whether the tool is active.
curl https://api.ravan.ai/api/v1/tools/019d1fdb-3977-7bd5-ab27-8d3b37ddf4fc/ \
-H "X-Api-Key: YOUR_API_KEY"
{
"success": true,
"message": "Tool fetched successfully",
"data": {
"id": "019d1fdb-3977-7bd5-ab27-8d3b37ddf4fc",
"organizationId": "1268c1f0-19f3-47db-aefb-c16a7c3ace6e",
"name": "check_order_status",
"description": "Look up the current status of a customer order by order ID",
"type": "function",
"definition": {
"name": "check_order_status",
"description": "Look up the current status of a customer order",
"parameters": {
"type": "object",
"properties": {
"order_id": {
"type": "string",
"description": "The unique order identifier"
}
},
"required": ["order_id"]
}
},
"isActive": true
}
}
⌘I