Get variable

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/api-tool-variable/<variableID> \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/api-tool-variable/<variableID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/api-tool-variable/<variableID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "variable": {
    "id": "<string>",
    "name": "<string>",
    "apiToolID": "<string>",
    "createdAt": "2026-09-10T00:00:00.000Z",
    "updatedAt": "2026-09-10T00:00:00.000Z",
    "description": "<string>"
  }
}

Get variable

Returns a single API tool variable by ID, with the fields that define it. An API tool variable is an input an API tool substitutes into its request.

GET

/v1/stable/api-tool-variable/{variableID}

Get variable

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/api-tool-variable/<variableID> \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/api-tool-variable/<variableID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/api-tool-variable/<variableID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "variable": {
    "id": "<string>",
    "name": "<string>",
    "apiToolID": "<string>",
    "createdAt": "2026-09-10T00:00:00.000Z",
    "updatedAt": "2026-09-10T00:00:00.000Z",
    "description": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Voiceflow bearer token

Path Parameters

variableID

string

required

Query Parameters

projectID

string

required

The ID of the project to operate on.

environmentAlias

string

required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

Returns a single API tool variable, with the name its tool's request references, the description that tells the agent what value to supply, and the ID of the API tool that owns it.

variable

object

required

Show child attributes

string

required

name

string

required

The name of the variable, referenced within the API tool request.

apiToolID

string

required

The ID of the API tool this variable belongs to.

createdAt

string

required

updatedAt

string

required

description

string

required

A description of the variable, used by the agent to determine what value to provide.

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks

Get variable

Authorizations

Path Parameters

Query Parameters

Response

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks