List Custom Variables

Retrieves all custom variables defined for the application. Use this endpoint to view and manage dynamic variables used in agent instructions.

Variable types: Custom variables can source values from message metadata, user metadata, or constant values. Each variable includes its source type, resolution path, and default value.

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

List Custom Variables

cURL

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

200

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "appId": "my-app-id",
    "name": "user.plan",
    "description": "The user subscription plan",
    "sourceType": "user_metadata",
    "sourcePath": "metadata.plan",
    "constantValue": "",
    "defaultValue": "free",
    "category": "custom",
    "createdAt": 1700000000000,
    "updatedAt": 1700000000000
  }
]

Authorizations

apikey · string · header · required

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

Response

200

application/json

List of custom variables

_id · string

Example:

"507f1f77bcf86cd799439011"

appId · string

Example:

"my-app-id"

name · string

Example:

"user.plan"

description · string

Example:

"The user subscription plan"

sourceType · enum<string>

Available options: message_metadata, user_metadata, constant

Example:

"user_metadata"

sourcePath · string

Example:

"metadata.plan"

constantValue · string

Example:

""

defaultValue · string

Example:

"free"

category · enum<string>

Available options: custom

Example:

"custom"

createdAt · number

Example:

1700000000000

updatedAt · number

Example:

1700000000000