Variables

Variables API

Overview

The Variables API provides read access to the Variables configured for your AI Agent. Variables store information collected during a conversation, such as an end user’s email or order number, so it can be reused across the AI Agent’s logic.

The API exposes the Variables that appear on the dashboard. Reserved and internal Variables are not returned. Each Variable is identified by an id, which is used to reference it from other resources.

Endpoints

Two read endpoints are available:

  • List Variables (GET /v2/variables): Returns every accessible Variable for the AI Agent.
  • Get a Variable (GET /v2/variables/{id}): Returns a single Variable by its id. An unknown, malformed, or reserved id returns a 404.

Both endpoints return each Variable as a summary containing its id and name.

Authentication

Requests are authenticated with a Bearer API key. See Authentication for details on generating and using API keys.