List Agent Tools

curl --request GET \
  --url https://api.ravan.ai/api/v1/tools/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ravan.ai/api/v1/tools/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ravan.ai/api/v1/tools/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ravan.ai/api/v1/tools/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ravan.ai/api/v1/tools/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Tools 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"
        ]
      }
    }
  ],
  "meta": {
    "total": "5",
    "limit": 20,
    "offset": 0
  }
}

GET

api

tools

List Agent Tools

curl --request GET \
  --url https://api.ravan.ai/api/v1/tools/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ravan.ai/api/v1/tools/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ravan.ai/api/v1/tools/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ravan.ai/api/v1/tools/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ravan.ai/api/v1/tools/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Tools 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"
        ]
      }
    }
  ],
  "meta": {
    "total": "5",
    "limit": 20,
    "offset": 0
  }
}

Authorizations

string

required

Bearer JWT used to authenticate the request for the organization scope.

Query Parameters

integer

Maximum number of records to return.

integer

Number of records to skip before returning results.

string

Filter tools to one agent UUID. The API also accepts agent_id.

Response

boolean

Whether the request succeeded.

string

Human-readable status message.

object[]

Returned tools.

Show data[]

string

Tool UUID.

string

Organization UUID.

string

Tool name.

string

Tool description.

string

Tool type.

object

Tool definition payload.

boolean

Whether the tool is active.

string

Agent UUID attached to the tool.

object

Enabled tool functions.

object

Pagination metadata.

Show meta

string

Total number of matching tools.

integer

Applied page size.

integer

Applied pagination offset.

{
  "success": true,
  "message": "Tools 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"
        ]
      }
    }
  ],
  "meta": {
    "total": "5",
    "limit": 20,
    "offset": 0
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

integer<int32>

Maximum number of records to return.

offset

integer<int32>

Number of records to skip before returning results.

agentId

string<uuid>

Filter tools to a single agent UUID.

agent_id

string<uuid>

Alias for agentId.

Response

Tools fetched successfully

success

boolean

Example:

true

message

string

Example:

"Tools fetched successfully"

data

object[]

Show child attributes

Introduction

Agent API

Organization API

Agent Tool API

Phone Number & Telephony API

Campaign API

Contact API

Calling API

Appointment API

GHL Integration API

Cal.com Integration API

RAG Knowledge Base API

Webhooks

Health API

List Agent Tools

Authorizations

Query Parameters

Response

Authorizations

Query Parameters

Response

​Authorizations

​Query Parameters

​Response

Authorizations

Query Parameters

Response

Authorizations

Query Parameters

Response