curl --request POST \ --url https://realtime-api.voiceflow.com/v1/stable/tool/<toolID>/move \ --header 'Authorization: Bearer <token>' --header 'Content-Type: application/json' \ --data '{ "type": "api", "target": { "global": true, "playbookID": "<string>" } }'

{ "tool": { "id": "<string>", "createdAt": "2026-09-10T00:00:00.000Z", "updatedAt": "2026-09-10T00:00:00.000Z", "messages": "<StableToolMessages>", "toolSound": "<ToolNodeDataToolSound>", "description": "<string>", "captureInputVariables": {}, "type": "api", "apiToolID": "<string>", "asyncExecution": true, "inputVariables": {}, "captureResponse": {} } }

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

Body

type

enum<string>

required

The type of the tool to move. workflow is refused: a workflow tool stays on the agent.

Available options: api, mcp, function, integration, workflow

target

object

required

Show child attributes

global

boolean

Target the agent. Cannot be used with playbookID.

playbookID

string

Target a specific playbook. Cannot be used with global.

Response

200 - application/json

tool

object

required

Show child attributes

Option 1

Show child attributes

string

required

createdAt

string

required

updatedAt

string

required

messages

object

required

Show child attributes

generative

object

object · 4 attributes: execution, failure, delay, completion

delayMessageID

string

required

failureMessageID

string

required

executionMessageID

string

required

completionMessageID

string

required

delayMessageSeconds

number

required

toolSound

object

required

The sound played while the tool runs, as the editor sets it, or null for none.

Show child attributes

ref

string

required

volume

number

default:0.75

description

string

required

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

captureInputVariables

object

required

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

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.

asyncExecution

boolean

required

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

inputVariables

object

required

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

captureResponse

object

required

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

Option 2

Show child attributes

string

required

createdAt

string

required

updatedAt

string

required

messages

object

required

Show child attributes

generative

object

object · 4 attributes: execution, failure, delay, completion

delayMessageID

string

required

failureMessageID

string

required

executionMessageID

string

required

completionMessageID

string

required

delayMessageSeconds

number

required

toolSound

object

required

The sound played while the tool runs, as the editor sets it, or null for none.

Show child attributes

ref

string

required

volume

number

default:0.75

description

string

required

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

captureInputVariables

object

required

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

type

enum<string>

required

Discriminator indicating this tool executes a custom function.

Available options: function

functionID

string

required

The ID of the function resource this tool executes.

asyncExecution

boolean

required

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

inputVariables

object

required

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

captureResponse

object

required

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

Option 3

Show child attributes

string

required

createdAt

string

required

updatedAt

string

required

messages

object

required

Show child attributes

generative

object

object · 4 attributes: execution, failure, delay, completion

delayMessageID

string

required

failureMessageID

string

required

executionMessageID

string

required

completionMessageID

string

required

delayMessageSeconds

number

required

toolSound

object

required

The sound played while the tool runs, as the editor sets it, or null for none.

Show child attributes

ref

string

required

volume

number

default:0.75

description

string

required

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

captureInputVariables

object

required

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

type

enum<string>

required

Discriminator indicating this tool calls a tool from an MCP server.

Available options: mcp

mcpToolID

string

required

The ID of the MCP tool resource this tool calls.

inputVariables

object

required

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

captureResponse

object

required

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

Option 4

Show child attributes

string

required

createdAt

string

required

updatedAt

string

required

messages

object

required

Show child attributes

generative

object

object · 4 attributes: execution, failure, delay, completion

delayMessageID

string

required

failureMessageID

string

required

executionMessageID

string

required

completionMessageID

string

required

delayMessageSeconds

number

required

toolSound

object

required

The sound played while the tool runs, as the editor sets it, or null for none.

Show child attributes

ref

string

required

volume

number

default:0.75

description

string

required

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

captureInputVariables

object

required

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

type

enum<string>

required

Discriminator indicating this tool calls a connected first-party integration.

Available options: integration

integrationToolID

string

required

The ID of the integration tool resource this tool calls.

inputVariables

object

required

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

captureResponse

object

required

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

extendedInputVariables

object

required

The refined schema of nested inputs the editor stores for some integrations, keyed by input. Copy it as read; null when there is none.

Move tool

Authorizations

Path Parameters

Query Parameters

Body

Response

TEXT