Skip to main content
PATCH
/
api
/
v1
/
tools
/
{id}
/
Update Agent Tool
curl --request PATCH \
  --url https://api.ravan.ai/api/v1/tools/{id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "type": "<string>",
  "definition": {}
}
'
{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "id": "id_123",
    "organizationId": "organization_123",
    "name": "Support Bot",
    "description": "Example description",
    "type": "twilio",
    "definition": {},
    "isActive": true
  }
}

​
Authorizations

​
X-Api-Key
string
required
Your Agni API key used to authenticate the request. Pass it in the X-Api-Key header. Find or rotate it from your Ravan AI account settings.

​
Path Parameters

​
id
string
required
The unique ID of the resource in the path. Use the ID returned by the related create or list endpoint.

​
Body

​
name
string
The internal name of the resource. Use a clear name that your team can recognize in the dashboard and API responses.
​
description
string
A short description of the resource. Use it to explain the purpose, behavior, or usage context.
​
type
string
The tool type. Use the value that matches how the agent should execute the tool, such as an API or integration tool.
​
definition
object
The tool definition object. Include the schema, parameters, and execution details required by the tool type.

​
Response

​
success
boolean
Whether the request succeeded.
​
message
string
Human-readable status message.
​
data
object
Returned data.
{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "id": "id_123",
    "organizationId": "organization_123",
    "name": "Support Bot",
    "description": "Example description",
    "type": "twilio",
    "definition": {},
    "isActive": true
  }
}

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

200 - application/json

Successful response

​
success
boolean
​
message
string
​
data
object