PATCH
/
api
/
v1
/
tools
/
{id}
curl -X PATCH https://api.ravan.ai/api/v1/tools/019d1fdb-3977-7bd5-ab27-8d3b37ddf4fc/ \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Check the real-time shipping status of a customer order"
  }'
{
  "success": true,
  "message": "Tool updated successfully",
  "data": {
    "id": "019d1fdb-3977-7bd5-ab27-8d3b37ddf4fc",
    "organizationId": "1268c1f0-19f3-47db-aefb-c16a7c3ace6e",
    "name": "check_order_status",
    "description": "Check the real-time shipping status of a customer order",
    "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": false
  }
}
This is a partial update (PATCH). Only include the fields you want to change.

Authorizations

X-Api-Key
string
required
Your Agni API key. Find it in your support@ravan.ai under Settings → API Keys.

Path Parameters

id
string
required
The unique UUID of the tool to update.

Body

name
string
Updated tool name (lowercase, underscores, no spaces).
description
string
Updated description of what the tool does.
type
string
Updated tool type — function or webhook.
definition
object
Updated JSON Schema definition with parameter schema.

Response

success
boolean
Whether the request succeeded.
message
string
Human-readable status message.
data
object
The updated tool object.
curl -X PATCH https://api.ravan.ai/api/v1/tools/019d1fdb-3977-7bd5-ab27-8d3b37ddf4fc/ \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Check the real-time shipping status of a customer order"
  }'
{
  "success": true,
  "message": "Tool updated successfully",
  "data": {
    "id": "019d1fdb-3977-7bd5-ab27-8d3b37ddf4fc",
    "organizationId": "1268c1f0-19f3-47db-aefb-c16a7c3ace6e",
    "name": "check_order_status",
    "description": "Check the real-time shipping status of a customer order",
    "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": false
  }
}

Authorizations

X-Api-Key
string
header
required

Path Parameters

id
string
required

Tool ID

Body

application/json
name
string
description
string
type
string
definition
object

Response

Successful response

success
boolean
message
string
data
object