Skip to main content
GET
/
api
/
v1
/
tools
/
{id}
/
Get Agent Tool
curl --request GET \
  --url https://api.ravan.ai/api/v1/tools/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Tool fetched successfully",
  "data": {
    "id": "1a2b3c4d-1111-2222-3333-444455556666",
    "organizationId": "0b8e2f10-1234-4abc-9def-567890abcdef",
    "name": "book_appointment",
    "description": "Books an appointment in the connected calendar",
    "type": "custom",
    "definition": {
      "url": "https://example.com/book",
      "method": "POST",
      "parameters": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string"
          }
        }
      }
    },
    "isActive": true,
    "agentId": "9f1c2b3a-4d5e-6f70-8190-a1b2c3d4e5f6",
    "enabledFunctions": {
      "values": [
        "book",
        "reschedule"
      ]
    }
  }
}

Authorizations

Authorization
string
required
Bearer JWT used to authenticate the request for the organization scope.

Path Parameters

id
string
required
Tool UUID.

Response

success
boolean
Whether the request succeeded.
message
string
Human-readable status message.
data
object
Returned tool.
{
  "success": true,
  "message": "Tool fetched successfully",
  "data": {
    "id": "1a2b3c4d-1111-2222-3333-444455556666",
    "organizationId": "0b8e2f10-1234-4abc-9def-567890abcdef",
    "name": "book_appointment",
    "description": "Books an appointment in the connected calendar",
    "type": "custom",
    "definition": {
      "url": "https://example.com/book",
      "method": "POST",
      "parameters": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string"
          }
        }
      }
    },
    "isActive": true,
    "agentId": "9f1c2b3a-4d5e-6f70-8190-a1b2c3d4e5f6",
    "enabledFunctions": {
      "values": [
        "book",
        "reschedule"
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Tool UUID.

Response

Tool fetched successfully

success
boolean
Example:

true

message
string
Example:

"Tool fetched successfully"

data
object