List BYO Agents

Retrieves all BYO agents configured for your CometChat app. Use this endpoint to view all registered BYO (Bring Your Own) agents and their current configuration.

GET /ai-agents/agents

List BYO Agents

cURL

curl --request GET \
  --url https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agents \
  --header 'apikey: <api-key>'

200

[
  {
    "name": "<string>",
    "description": "<string>",
    "deploymentUrl": "<string>",
    "apiKey": "<string>"
  }
]

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Response

200 - application/json

List of agents

name · string · required

description · string · required

deploymentUrl · string · required

apiKey · string · required