Voiceflow bearer token
API Tools
Let your agent call an external API.
See Authentication for credentials and permissions.
Legacy - 2026/07
Returns every API tool in the environment. An API tool is a saved HTTP request an agent can make. 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).
Response
Returns every API tool saved in the project's environment, each with its HTTP method, URL, headers, query parameters, body, and the description the agent uses to decide when to call it.
Legacy - 2026/07
Adds a API tool to the environment, a saved HTTP request an agent can make. 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
get, put, post, patch, deleteA description of what the API tool does, used by the agent to decide when to call it.
Response
Creates the API tool and returns it in full, including its new ID and the request it will send: HTTP method, URL, headers, query parameters, and body.
Current - 2026/09
Returns every API tool in the environment. An API tool is a saved HTTP request an agent can make; its URL, header values, and query parameter values are plain strings that reference the tool's inputs as {input_name}. 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).
Response
Returns every API tool saved in the project's environment, each with its HTTP method, URL, headers, query parameters, body, and the description the agent uses to decide when to call it.
Current - 2026/09
Adds an API tool to the environment, a saved HTTP request an agent can make. The URL, header values, and query parameter values are plain strings that reference the tool's inputs as {input_name}, and 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
get, put, post, patch, deleteA description of what the API tool does, used by the agent to decide when to call it.
Response
Creates the API tool and returns it in full, including its new ID and the request it will send: HTTP method, URL, headers, query parameters, and body.
References this write kept as literal text instead of binding, each with the reason. The write still succeeded.
Legacy - 2026/07
Adds several API tools to the environment in one request, each taking the fields the single-create call takes. The response carries the created API tools 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
Response
Creates every API tool in the request and returns them all, each with its own ID and complete saved request definition.
Current - 2026/09
Adds several API tools to the environment in one request, each taking the fields the single-create call takes, with URL and header values as plain strings. The response carries the created API tools 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
Response
Creates every API tool in the request and returns them all, each with its own ID and complete saved request definition.
References this write kept as literal text instead of binding, each with the reason. The write still succeeded.
Legacy - 2026/07
Returns a single API tool by ID, with the fields that define it. An API tool is a saved HTTP request an agent can make.
Authentication
Voiceflow bearer token
Path parameters
The ID of the tool 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, with the complete request it sends: HTTP method, URL, headers, query parameters, and body, plus any settings saved on it.
Legacy - 2026/07
Changes an existing API tool in place. The response carries only a confirmation message, so refetch the API tool to read its new values.
Authentication
Voiceflow bearer token
Path parameters
The ID of the tool 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 description of what the API tool does, used by the agent to decide when to call it.
Response
Confirms the API tool was updated. The response carries a message only, not the revised tool, so fetch the API tool again to read back the request it now sends.
A human-readable message confirming the update.
Deletes a single API tool by ID. An API tool is a saved HTTP request an agent can make. The response carries only a confirmation message, so refetch the API tools to see what is left.
Authentication
Voiceflow bearer token
Path parameters
The ID of the tool 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 was deleted. Only a confirmation message comes back, so refetch the project's API tools to see what remains.
A human-readable message confirming the deletion.
Current - 2026/09
Returns a single API tool by ID, with the fields that define it. An API tool is a saved HTTP request an agent can make; its URL, header values, and query parameter values come back as plain strings.
Authentication
Voiceflow bearer token
Path parameters
The ID of the tool 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, with the complete request it sends: HTTP method, URL, headers, query parameters, and body, plus any settings saved on it.
Current - 2026/09
Changes an existing API tool in place, taking URL and header values as plain strings that reference the tool's inputs as {input_name}. The response lists any references that did not resolve; read the API tool again to see its new values.
Authentication
Voiceflow bearer token
Path parameters
The ID of the tool 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 description of what the API tool does, used by the agent to decide when to call it.
Response
Confirms the API tool was updated. The response carries a message only, not the revised tool, so fetch the API tool again to read back the request it now sends.
A human-readable message confirming the update.
References this write kept as literal text instead of binding, each with the reason. The write still succeeded.
Returns the input variables an API tool declares, which are the names the execute call needs a value for. Call it before executing so the request body has every input.
Authentication
Voiceflow bearer token
Path parameters
The ID of the API tool whose inputs to list.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
Returns the API tool's inputs, sorted by name, each one a required string.
The inputs execute takes, one per input variable, sorted by name. Every one is a required string. A credential input usually gets its secret from the attachment's default; write that secret's name as {secret_name} in the value.
Sends an API tool's saved request once, filling its input placeholders from the inputs in the body. The call stops at the tool's timeout or 18 seconds, whichever is shorter, and nothing is saved.
Authentication
Voiceflow bearer token
Path parameters
The ID of the API tool to execute.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
A value for each of the API tool's input variables, keyed by input name. Each value replaces the tool's {input_name} placeholder in the URL, headers, query and body. Every declared input needs a value, and a name the tool does not declare is refused. List them with get_schema.
Response
Returns the endpoint's HTTP status, status text, headers, and parsed body, with success, latencyMs, and error fields. Secret values read [secret] wherever they appear.
Whether the tool ran and reported no error.
How long the run took, in milliseconds, measured by this API around the call.
Why the run failed when success is false, otherwise null. Secret values read [secret].
Whether a returned payload was over 64 KB and was cut to its first 64 KB of JSON text, which then arrives as a string.
What the endpoint returned. Null only when general-runtime did not answer in time.