Get Dynamic Variables | SpeechifyAI API

Retrieve the agent’s customer-scope dynamic variables and the read-only catalogue of reserved system__* keys. The system variables list is provided so editor UIs can render the reference list without maintaining a client-side copy of the catalogue.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

agent_idstringRequired

Agent id (prefixed external id, agent_...).

Response headers

X-Request-IDstring

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an X-Request-ID request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an `X-Request-ID` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope.

Response

The agent's variable catalogue.

variableslist of objects

Customer-defined variables for this agent.

system_variableslist of objects

Platform-populated system__* variables, provided for reference. This list is the same for every agent.

Errors

401

Unauthorized Error

404

Not Found Error

1	{
2	"variables": [
3	{
4	"key": "product_name",
5	"type": "string",
6	"default": null,
7	"description": "Name of the product the agent is supporting."
8	}
9	],
10	"system_variables": [
11	{
12	"key": "product_name",
13	"description": "Example description."
14	}
15	]
16	}