Voiceflow bearer token
API Tool Variables
Define the inputs and outputs of an API tool.
See Authentication for credentials and permissions.
Legacy - 2026/07
Returns every API tool variable in its API tool. An API tool variable is an input an API tool substitutes into its request. The call takes no paging parameters, so one request yields the whole set.
Authentication
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
The ID of the API tool whose variables to list.
Response
Returns every variable defined on a single API tool, selected by the apiToolID query parameter rather than across the whole project. Each carries the name the tool's request references and a description telling the agent what value to provide.
Legacy - 2026/07
Adds a API tool variable to its API tool, an input an API tool substitutes into its request. The response carries the ID that later calls address it by.
Authentication
Voiceflow bearer token
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, referenced within the API tool request.
The ID of the API tool this variable belongs to.
A description of the variable, used by the agent to determine what value to provide.
Response
Creates the API tool variable and returns it, including its new ID and the apiToolID of the API tool it now belongs to.
Current - 2026/09
Returns every API tool variable in its API tool. An API tool variable is an input an API tool substitutes into its request. The call takes no paging parameters, so one request yields the whole set.
Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
The ID of the API tool whose variables to list.
Response
Returns every variable defined on a single API tool, selected by the apiToolID query parameter rather than across the whole project. Each carries the name the tool's request references and a description telling the agent what value to provide.
Current - 2026/09
Adds an API tool variable to its API tool, an input an API tool substitutes into its request. The response carries the ID that later calls address it by.
Authentication
Voiceflow bearer token
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, referenced within the API tool request as {name}. Letters, digits and underscores only, at most 64 characters.
The ID of the API tool this variable belongs to.
A description of the variable, used by the agent to determine what value to provide.
Response
Creates the API tool variable and returns it, including its new ID and the apiToolID of the API tool it now belongs to.
Legacy - 2026/07
Adds several API tool variables to its API tool in one request, each taking the fields the single-create call takes. The response carries the created API tool variables in the same shape the list call returns.
Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The ID of the API tool to create the variables under.
Response
Returns the newly created API tool variables, each with its own ID and the apiToolID of the API tool it was attached to.
Current - 2026/09
Adds several API tool variables to its API tool in one request, each taking the fields the single-create call takes. The response carries the created API tool variables in the same shape the list call returns.
Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The ID of the API tool to create the variables under.
Response
Returns the newly created API tool variables, each with its own ID and the apiToolID of the API tool it was attached to.
Legacy - 2026/07
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.
Authentication
Voiceflow bearer token
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 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.
Legacy - 2026/07
Changes an existing API tool variable in place. The response carries only a confirmation message, so refetch the API tool variable to read its new values.
Authentication
Voiceflow bearer token
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, referenced within the API tool request.
A description of the variable, used by the agent to determine what value to provide.
Response
Confirms the API tool variable was updated. The body is a confirmation rather than the updated variable, so fetch the variable again to see its current name and description.
A human-readable message confirming the update.
Deletes a single API tool variable by ID. An API tool variable is an input an API tool substitutes into its request. The response carries only a confirmation message, so refetch the API tool variables to see what is left.
Authentication
Voiceflow bearer token
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 API tool variable was deleted. Nothing but a message is returned, so refetch the tool's variables to see which names its request can still reference.
A human-readable message confirming the deletion.
Current - 2026/09
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.
Authentication
Voiceflow bearer token
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 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.
Current - 2026/09
Changes an existing API tool variable in place. The response carries only a confirmation message, so refetch the API tool variable to read its new values.
Authentication
Voiceflow bearer token
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, referenced within the API tool request as {name}. Letters, digits and underscores only, at most 64 characters.
A description of the variable, used by the agent to determine what value to provide.
Response
Confirms the API tool variable was updated. The body is a confirmation rather than the updated variable, so fetch the variable again to see its current name and description.
A human-readable message confirming the update.