List Agent Tools and Actions
curl --request GET \
--url https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}/enabled-items \
--header 'apikey: <api-key>'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}/enabled-items"
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/agent-builder/agents/{uid}/enabled-items', 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/agent-builder/agents/{uid}/enabled-items",
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/agent-builder/agents/{uid}/enabled-items"
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/agent-builder/agents/{uid}/enabled-items")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}/enabled-items")
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{
"data": {
"tools": [
{
"slug": "gmail",
"name": "Gmail",
"description": "Gmail integration",
"icon": "https://example.com/gmail-icon.png",
"actions": [
{
"slug": "GMAIL_SEND_EMAIL",
"name": "Send Email",
"description": "Send an email via Gmail"
}
]
}
],
"frontendActions": [
{
"id": "myapp_onUserClick",
"name": "User Click Action",
"description": "Triggered when a user clicks a button",
"triggerFunction": "onUserClick",
"parameters": [
{
"key": "userId",
"type": "string",
"description": "The user identifier",
"required": true
}
]
}
],
"apiTools": [
{
"slug": "my-api-tool",
"name": "My API Tool",
"description": "Calls an external API",
"icon": "https://example.com/icon.png",
"endpoint": "https://api.example.com/search",
"method": "GET",
"parameters": [
{
"key": "query",
"type": "string",
"description": "The search query",
"required": true
}
]
}
],
"mcpServers": [
{
"slug": "my-mcp-server",
"name": "My MCP Server",
"description": "A Model Context Protocol server",
"icon": "https://example.com/icon.png",
"url": "https://mcp.example.com/sse"
}
]
}
}Agents
List Agent Tools and Actions
Retrieves all enabled items for a specific agent, categorized by type. Use this endpoint to see which tools, frontend actions, API tools, and MCP servers are currently enabled for an agent. **Categor
GET
/
ai-agents
/
agent-builder
/
agents
/
{uid}
/
enabled-items
List Agent Tools and Actions
curl --request GET \
--url https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}/enabled-items \
--header 'apikey: <api-key>'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}/enabled-items"
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/agent-builder/agents/{uid}/enabled-items', 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/agent-builder/agents/{uid}/enabled-items",
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/agent-builder/agents/{uid}/enabled-items"
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/agent-builder/agents/{uid}/enabled-items")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/{uid}/enabled-items")
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{
"data": {
"tools": [
{
"slug": "gmail",
"name": "Gmail",
"description": "Gmail integration",
"icon": "https://example.com/gmail-icon.png",
"actions": [
{
"slug": "GMAIL_SEND_EMAIL",
"name": "Send Email",
"description": "Send an email via Gmail"
}
]
}
],
"frontendActions": [
{
"id": "myapp_onUserClick",
"name": "User Click Action",
"description": "Triggered when a user clicks a button",
"triggerFunction": "onUserClick",
"parameters": [
{
"key": "userId",
"type": "string",
"description": "The user identifier",
"required": true
}
]
}
],
"apiTools": [
{
"slug": "my-api-tool",
"name": "My API Tool",
"description": "Calls an external API",
"icon": "https://example.com/icon.png",
"endpoint": "https://api.example.com/search",
"method": "GET",
"parameters": [
{
"key": "query",
"type": "string",
"description": "The search query",
"required": true
}
]
}
],
"mcpServers": [
{
"slug": "my-mcp-server",
"name": "My MCP Server",
"description": "A Model Context Protocol server",
"icon": "https://example.com/icon.png",
"url": "https://mcp.example.com/sse"
}
]
}
}For the complete error reference, see Error Guide.
Authorizations
API Key (i.e. Rest API Key from the Dashboard).
Path Parameters
Unique identifier of the agent
Query Parameters
Include enabled tools (default: true)
Include enabled frontend actions (default: true)
Include enabled API tools (default: true)
Include enabled MCP servers (default: true)
Search term to filter by name/description
Response
200 - application/json
Categorized enabled items for the agent
Show child attributes
Show child attributes
Was this page helpful?
⌘I