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/?limit=10&offset=0 \
-H "X-Api-Key: YOUR_API_KEY"
{
"success": true,
"message": "Tools 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
}
],
"meta": {
"total": 1,
"limit": 10,
"offset": 0
}
}
Agent Tool API
List Agent Tools
Retrieve a paginated list of all custom tools (functions, webhooks) available in your organization.
GET
/
api
/
v1
/
tools
curl https://api.ravan.ai/api/v1/tools/?limit=10&offset=0 \
-H "X-Api-Key: YOUR_API_KEY"
{
"success": true,
"message": "Tools 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
}
],
"meta": {
"total": 1,
"limit": 10,
"offset": 0
}
}
Authorizations
Your Agni API key. Find it in your support@ravan.ai under Settings → API Keys.
Query Parameters
Maximum number of tools to return per page.
Number of records to skip for pagination. Defaults to
0.Response
Whether the request succeeded.
Human-readable status message.
Array of tool objects.
Show data[]
Show data[]
Unique tool ID (UUID).
ID of the organization that owns this tool.
Tool name. Must be a valid function name (lowercase, underscores, no spaces).
Human-readable description of what the tool does. This is shown to the LLM to decide when to invoke the tool.
Tool type — e.g.
function, webhook.JSON Schema definition of the tool including its name, description, and parameter schema. Follows the OpenAI function calling format.
Whether the tool is currently active and available for agents to use.
curl https://api.ravan.ai/api/v1/tools/?limit=10&offset=0 \
-H "X-Api-Key: YOUR_API_KEY"
{
"success": true,
"message": "Tools 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
}
],
"meta": {
"total": 1,
"limit": 10,
"offset": 0
}
}
⌘I