The ID of the project to operate on.
Variables
Store and update context for your agent.
See Authentication for credentials and permissions.
Legacy - 2026/07
Returns every variable in the project. A variable is a named slot of project state an agent can read and write. The call takes no paging parameters, so one request yields the whole set.
Query parameters
The alias of the environment to operate on (e.g. main).
Response
Returns every variable defined in the project environment, each with its name, description, default value, colour, and whether the platform owns it as a system variable.
Legacy - 2026/07
Adds a variable to the project, a named slot of project state an agent can read and write. The response carries the ID that later calls address it by.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The display color of the variable in the Voiceflow editor.
The initial value of the variable at the start of a conversation.
More parameters
description
A short description of what the variable stores.
Response
Returns the newly created variable in full, including the ID assigned to it and its creation timestamps.
Current - 2026/09
Returns every variable in the project. A variable is a named slot of project state an agent can read and write. The call takes no paging parameters, so one request yields the whole set.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
Returns every variable defined in the project environment, each with its name, description, default value, color, and whether the platform owns it as a system variable.
Current - 2026/09
Adds a variable to the project, a named slot of project state an agent can read and write. The name takes letters, digits and underscores only, up to 64 characters, and must not already be used by a variable or entity in the environment. The response carries the ID that later calls address it by.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The name of the variable. Letters, digits and underscores only, at most 64 characters — this is what a {token} in a text field binds to. Must not already be used by a variable or an entity in this environment. When updating, omit this field unless you are renaming: a variable stored before this rule can hold a name outside the grammar, and echoing that name back would be rejected.
The display color of the variable in the Voiceflow editor, as a hex code from the editor's color picker. Use #515A63 (the editor's default) unless the user asks for a color; otherwise pick the closest of #5B9FD7, #CB627B, #56B365, #DC8879, #9A63BC. Do not invent other hex codes.
The initial value of the variable at the start of a conversation.
More parameters
description
A short description of what the variable stores.
Response
Returns the newly created variable in full, including the ID assigned to it and its creation timestamps.
Legacy - 2026/07
Adds several variables to the project in one request, each taking the fields the single-create call takes. The response carries the created variables in the same shape the list call returns.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
Response
Returns the variables the request created, as an array, each carrying the ID assigned to it.
Current - 2026/09
Adds several variables to the project in one request, each taking the fields the single-create call takes, including its name rules. The response carries the created variables in the same shape the list call returns.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
Response
Returns the variables the request created, as an array, each carrying the ID assigned to it.
Legacy - 2026/07
Returns a single variable by ID, with the fields that define it. A variable is a named slot of project state an agent can read and write.
Path parameters
The ID of the variable to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
Returns a single variable by ID, carrying its current description, default value, colour, and timestamps.
Legacy - 2026/07
Changes an existing variable in place. The response carries only a confirmation message, so refetch the variable to read its new values.
Path parameters
The ID of the variable to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
A short description of what the variable stores.
The initial value of the variable at the start of a conversation.
More parameters
color
The display color of the variable in the Voiceflow editor.
Response
Confirms the variable was updated. The body is a message rather than the revised variable, so read the variable back to see its new default value or description.
A human-readable message confirming the update.
Deletes a single variable by ID. A variable is a named slot of project state an agent can read and write. The response carries only a confirmation message, so refetch the variables to see what is left.
Path parameters
The ID of the variable to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
Confirms the variable was deleted. Only a message comes back, so refresh any cached copy of the project's variables.
A human-readable message confirming the deletion.
Error 404
No variable with that ID exists in the project and environment. A delete that has already succeeded returns this on a second attempt, so the operation is not idempotent - treat a 404 here as "already gone" rather than as a failure worth retrying.
Current - 2026/09
Returns a single variable by ID, with the fields that define it. A variable is a named slot of project state an agent can read and write.
Path parameters
The ID of the variable to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
Returns a single variable by ID, carrying its current description, default value, color, and timestamps.
Current - 2026/09
Changes an existing variable in place. Send name only when renaming, because a new name must use letters, digits and underscores and be unused by any variable or entity in the environment. The response carries only a confirmation message, so refetch the variable to read its new values.
Path parameters
The ID of the variable to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The name of the variable. Letters, digits and underscores only, at most 64 characters — this is what a {token} in a text field binds to. Must not already be used by a variable or an entity in this environment. When updating, omit this field unless you are renaming: a variable stored before this rule can hold a name outside the grammar, and echoing that name back would be rejected.
A short description of what the variable stores.
The initial value of the variable at the start of a conversation.
More parameters
color
The display color of the variable in the Voiceflow editor, as a hex code from the editor's color picker. Use #515A63 (the editor's default) unless the user asks for a color; otherwise pick the closest of #5B9FD7, #CB627B, #56B365, #DC8879, #9A63BC. Do not invent other hex codes.
Response
Confirms the variable was updated. The body is a message rather than the revised variable, so read the variable back to see its new default value or description.
A human-readable message confirming the update.