v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB

Flow Variables

Create agent variable

Creates a variable for an agent. Requires a USER API key.

post/public/v1/agents/{agentId}/variables

Path parameters

agentIdstring required

Example:uuid-xxxx-xxxx

Request body

namestring required

descriptionstring nullable

patternstring nullable

Example request

{
  "name": "customer_name",
  "description": "Customer name captured during the conversation",
  "pattern": "^[A-Za-z ]+$"
}

Response

Created variable

idnumber required

namestring required

descriptionstring nullable

status'ACTIVE' | 'DELETED' required

createdAtstring required

updatedAtstring required

assistantIdstring nullable

automationIdnumber nullable

patternstring nullable

defaultValuestring nullable

isDefaultboolean required

Example response

{
  "id": 123,
  "name": "customer_name",
  "description": "example",
  "status": "ACTIVE",
  "createdAt": "2024-01-01T12:00:00Z",
  "updatedAt": "2024-01-01T12:00:00Z",
  "assistantId": "example",
  "automationId": 1,
  "pattern": "example",
  "defaultValue": "example"
}