List Tools
curl --request GET \
--url https://{appid}.api-{region}.cometchat.io/v3/ai-agents/tools \
--header 'apikey: <api-key>'import requests
url = "https://{appid}.api-{region}.cometchat.io/v3/ai-agents/tools"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{appid}.api-{region}.cometchat.io/v3/ai-agents/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://{appid}.api-{region}.cometchat.io/v3/ai-agents/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 => [
"apikey: <api-key>"
],
]);
$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://{appid}.api-{region}.cometchat.io/v3/ai-agents/tools"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{appid}.api-{region}.cometchat.io/v3/ai-agents/tools")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appid}.api-{region}.cometchat.io/v3/ai-agents/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"_id": "myapp_myTool",
"appId": "my-app-id",
"name": "myTool",
"type": "action",
"displayName": "My Tool",
"executionText": "Running my tool...",
"doNotExecute": false,
"tool": {
"name": "myTool",
"description": "A helpful tool",
"parameters": {
"type": "object",
"properties": {},
"required": []
}
},
"createdAt": "2025-12-01T00:00:00.000Z",
"updatedAt": "2025-12-01T00:00:00.000Z"
}
]Tools
List Tools
Retrieves all tools configured for your CometChat app. Use this endpoint to view available tools and actions, or filter by type.
Filtering: Use the type query parameter to filter by action or tool.
GET
/
ai-agents
/
tools
List Tools
curl --request GET \
--url https://{appid}.api-{region}.cometchat.io/v3/ai-agents/tools \
--header 'apikey: <api-key>'import requests
url = "https://{appid}.api-{region}.cometchat.io/v3/ai-agents/tools"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{appid}.api-{region}.cometchat.io/v3/ai-agents/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://{appid}.api-{region}.cometchat.io/v3/ai-agents/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 => [
"apikey: <api-key>"
],
]);
$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://{appid}.api-{region}.cometchat.io/v3/ai-agents/tools"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{appid}.api-{region}.cometchat.io/v3/ai-agents/tools")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appid}.api-{region}.cometchat.io/v3/ai-agents/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"_id": "myapp_myTool",
"appId": "my-app-id",
"name": "myTool",
"type": "action",
"displayName": "My Tool",
"executionText": "Running my tool...",
"doNotExecute": false,
"tool": {
"name": "myTool",
"description": "A helpful tool",
"parameters": {
"type": "object",
"properties": {},
"required": []
}
},
"createdAt": "2025-12-01T00:00:00.000Z",
"updatedAt": "2025-12-01T00:00:00.000Z"
}
]Authorizations
API Key (i.e. Rest API Key from the Dashboard).
Query Parameters
Filter tools by type
Available options:
action, tool Response
200 - application/json
List of tools
Example:
"myapp_myTool"
Example:
"my-app-id"
Example:
"myTool"
Available options:
action, tool Example:
"action"
Example:
"My Tool"
Example:
"Running my tool..."
Example:
false
Show child attributes
Show child attributes
Was this page helpful?