Skip to main content
POST
Create tool

Authorizations

Authorization
string
header
required

Voiceflow bearer token

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).

Body

application/json
target
object
required
type
enum<string>
required

Discriminator indicating this tool executes a saved API request.

Available options:
api
apiToolID
string
required

The ID of the API resource this tool executes.

description
string | null

A description of what the tool does, used by the agent to decide when to call it.

messages
object | null
captureInputVariables
object | null

A map of tool input names to the variables or entities whose values are captured into them.

asyncExecution
boolean
default:false

When enabled, the tool runs in the background without blocking the conversation.

inputVariables
object

A map of input names to the values the agent supplies when calling the tool.

captureResponse
object

A map of variable names to the parts of the tool response captured into them.

Response

201 - application/json

Attaches an existing API tool, function, or MCP tool to the agent or to a playbook, and returns the attachment with its generated ID and wiring. The underlying resource is referenced by ID and is not created here.

tool
object
required