Skip to content
Core Concepts
/
Agents
/
/
Variables
Last updated

A Flow Variable is a named placeholder scoped to a single Agent's Flow. You capture or set its value at one node and reference it later as {VARIABLE_NAME} in any interpolable text field of the same flow.

Flow variables are scoped to one Agent. They are not visible to other agents and not shared with Workflow Variables.

Identity

FieldTypeNotes
idnumberUse as variableId.
namestringSnake-case by convention. Used inside {NAME} interpolation tags.
descriptionstring?
statusenumACTIVE · INACTIVE · ARCHIVED.
patternstring?Optional regex pattern. Used to validate captured values.
defaultValuestring?Value used when the variable has not been set yet.
isDefaultbooleantrue for variables that ship with the platform (e.g. customer_name).
assistantIdstringOwning agent (UUID).
createdAtstringISO timestamp.
updatedAtstringISO timestamp.

Where they interpolate

Reference variables in text fields as {VARIABLE_NAME}. The name must match exactly, including case.

Interpolable text fields inside a Flow:

  • API node: url, headers[].value, parameters[].value, body
  • Say AI: message, prompt
  • Response AI: instructions
  • Tools AI: instructions
  • Conditional Routing AI: conditions[].expression
  • Dynamic Tables: rowId, search, rowData values

Naming

  • Use snake_case (e.g. customer_name, order_id).
  • Must be unique within the agent. Use the check-name endpoint to test availability before creating.
  • Pick a name you can use as {name} directly in copy.

Operations

VerbPath
GET/public/v1/agents/{agentId}/variables
POST/public/v1/agents/{agentId}/variables
GET/public/v1/agents/{agentId}/variables/{variableId}
PUT/public/v1/agents/{agentId}/variables/{variableId}
DELETE/public/v1/agents/{agentId}/variables/{variableId}
GET/public/v1/agents/{agentId}/variables/all
GET/public/v1/agents/{agentId}/variables/check-name?name=...

All endpoints require a USER API key. Full details under the Flow Variables tag in the API Reference.

CLI

frontline agents variables list --table
frontline agents variables create --name customer_name --description "Captured customer name"
frontline agents variables check-name customer_name
frontline agents variables update 123 --name customer_name --pattern "^[A-Za-z ]+$"

Overview

Intents