List All Variables

Retrieves all enabled variables (predefined and custom) for the application. Use this endpoint to view variable definitions and understand where they are used.

Usage tracking: Each variable includes information showing which agents reference it in their instructions and which API tools use it.

Grouping: Set groupByCategory to true to group results by category (e.g., auth, custom); otherwise results are returned as a flat array.

GET /ai-agents/agent-builder/agents/variables/all

List All Variables

cURL

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

200

[
  {
    "name": "auth.uid",
    "description": "Authenticated user UID",
    "sourceType": "auth",
    "category": "auth",
    "usageCount": 2,
    "usedByAgents": [
      {
        "uid": "agent-1",
        "name": "Support Agent"
      }
    ],
    "usedByTools": {}
  }
]

Authorizations

apikey · string · header · required

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

Query Parameters

groupByCategory · boolean

Group variables by category

Response

200 - application/json

List of variables (flat array or grouped by category)

object[]

object

name · string

description · string

sourceType · string

category · string

usageCount · number

usedByAgents · object[]

usedByTools · object