Get API tool schema
GET
Get API tool schema

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

toolID
string
required

Query Parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

Returns the API tool's inputs, sorted by name, each one a required string.

inputs
object[]
required

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.

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.