List All Variables

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

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

GET

ai-agents

agent-builder

agents

variables

all

List All Variables

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

[
  {
    "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

BYO Agent APIs

Agent Builder APIs

List All Variables

Authorizations

Query Parameters

Response