Skip to main content
GET
/
ai-agents
/
agents
List BYO Agents
curl --request GET \
  --url https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agents \
  --header 'apikey: <api-key>'
[
  {
    "uid": "550e8400-e29b-41d4-a716-446655440000",
    "appId": "my-app-id",
    "name": "My Agent",
    "icon": "https://example.com/icon.png",
    "isActive": true,
    "integrateWith": "openai",
    "integrationType": "agent",
    "tools": [
      "tool1"
    ],
    "actions": [
      "action1"
    ],
    "instruction": "You are a helpful assistant",
    "integrationMeta": {},
    "metaData": {},
    "deletedAt": null,
    "createdAt": "2025-12-01T00:00:00.000Z",
    "updatedAt": "2025-12-01T00:00:00.000Z"
  }
]

Authorizations

​
apikey
string
header
required

API Key (i.e. Rest API Key from the Dashboard).

Response

200 - application/json

List of agents

​
uid
string

Unique identifier of the agent

​
appId
string

Application ID

​
name
string

Name of the agent

​
icon
string

URL to the agent's avatar

​
isActive
boolean

Whether the agent is active

​
integrateWith
string

Integration platform identifier

​
integrationType
string

Type of connection

​
tools
string[]

List of connected tools

​
actions
string[]

List of connected actions

​
integrationMeta
object

Integration-specific configuration

​
metaData
object

Agent metadata

​
_id
string

Internal document ID

​
createdAt
string<date-time>

Creation timestamp

​
updatedAt
string<date-time>

Last update timestamp