Skip to navigation

List agent variables

Returns the variables the organization declared for an agent, in the order they are stored, with the fixed value of the ones with source static. The variables the platform always provides are not listed. A legacy variable saved before the naming rules is listed with valid: false: the agent never uses it and it can only be deleted, with its exact name. Required scope: agents:operate. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing.

Authentication

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Path parameters

agent_idstringRequiredformat: "^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$"

Id of an agent of the organization, as returned by GET /agents.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:

Response

Successful response.
object"list"

Always list.

agent_idstring
Id of the agent the variables belong to.
datalist of objects

The variables declared by the organization for this agent (at most 30), in the order they are stored. Never the ones the platform always provides.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error