> ## Documentation Index > Fetch the complete documentation index at: https://www.voiceflow.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Move tool > Move a tool attachment to the agent or to a playbook. It keeps its ID, its fields and its messages. ## OpenAPI ````yaml /specs-prettified/realtime/openapi.stable.json post /v1/stable/tool/{toolID}/move openapi: 3.0.0 info: title: Realtime description: Realtime gateway API service version: 1.0.0 contact: {} servers: - url: https://realtime-api.voiceflow.com security: [] tags: [] paths: /v1/stable/tool/{toolID}/move: post: tags: - Tool summary: Move tool description: Move a tool attachment to the agent or to a playbook. It keeps its ID, its fields and its messages. operationId: StableToolController_move parameters: - name: toolID required: true in: path schema: type: string - name: projectID required: true in: query schema: type: string description: The ID of the project to operate on. - name: environmentAlias required: true in: query schema: type: string description: The alias of the environment to operate on (e.g. `main`). requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/StableToolMoveRequest" responses: "200": description: "" content: application/json: schema: $ref: "#/components/schemas/StableToolMoveResponse" security: - token: [] components: schemas: StableToolMoveRequest: type: object properties: type: type: string enum: - api - mcp - function - integration - workflow description: "The type of the tool to move. `workflow` is refused: a workflow tool stays on the agent." x-enumNames: - API - MCP - FUNCTION - INTEGRATION - WORKFLOW target: $ref: "#/components/schemas/StableToolTarget" required: - type - target additionalProperties: false StableToolTarget: type: object properties: global: description: Target the agent. Cannot be used with playbookID. type: boolean playbookID: description: Target a specific playbook. Cannot be used with global. type: string additionalProperties: false StableToolMoveResponse: type: object properties: tool: $ref: "#/components/schemas/StableToolV2" required: - tool StableToolV2: oneOf: - type: object properties: id: type: string createdAt: type: string format: date-time pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ updatedAt: type: string format: date-time pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ messages: nullable: true allOf: - $ref: "#/components/schemas/StableToolMessages" toolSound: nullable: true description: The sound played while the tool runs, as the editor sets it, or null for none. allOf: - $ref: "#/components/schemas/ToolNodeDataToolSound" description: nullable: true description: A description of what the tool does, used by the agent to decide when to call it. type: string captureInputVariables: nullable: true description: A map of tool input names to the variables or entities whose values are captured into them. type: object additionalProperties: $ref: "#/components/schemas/AgentToolCaptureInputVariable" type: type: string enum: - api description: Discriminator indicating this tool executes a saved API request. x-enumNames: - API apiToolID: type: string description: The ID of the API resource this tool executes. asyncExecution: type: boolean description: When enabled, the tool runs in the background without blocking the conversation. inputVariables: type: object additionalProperties: type: object properties: description: default: null nullable: true type: string defaultValue: default: null nullable: true allOf: - $ref: "#/components/schemas/DefaultValueString" apiToolInputVariableID: type: string captureType: allOf: - $ref: "#/components/schemas/ToolNodeCaptureType" required: type: boolean description: "Whether the agent must supply a value for this input. Omit it and the API infers: false when defaultValue holds a secret reference (the secret is injected and the model is never asked for it), true otherwise. Sending true together with a secret defaultValue is rejected." required: - apiToolInputVariableID - required description: A map of input names to the values the agent supplies when calling the tool. captureResponse: type: object additionalProperties: $ref: "#/components/schemas/ToolNodeDataAPICaptureResponse" description: A map of variable names to the parts of the tool response captured into them. required: - id - createdAt - updatedAt - messages - toolSound - description - captureInputVariables - type - apiToolID - asyncExecution - inputVariables - captureResponse - type: object properties: id: type: string createdAt: type: string format: date-time pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ updatedAt: type: string format: date-time pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ messages: nullable: true allOf: - $ref: "#/components/schemas/StableToolMessages" toolSound: nullable: true description: The sound played while the tool runs, as the editor sets it, or null for none. allOf: - $ref: "#/components/schemas/ToolNodeDataToolSound" description: nullable: true description: A description of what the tool does, used by the agent to decide when to call it. type: string captureInputVariables: nullable: true description: A map of tool input names to the variables or entities whose values are captured into them. type: object additionalProperties: $ref: "#/components/schemas/AgentToolCaptureInputVariable" type: type: string enum: - function description: Discriminator indicating this tool executes a custom function. x-enumNames: - FUNCTION functionID: type: string description: The ID of the function resource this tool executes. asyncExecution: type: boolean description: When enabled, the tool runs in the background without blocking the conversation. inputVariables: type: object additionalProperties: type: object properties: description: default: null nullable: true type: string defaultValue: default: null nullable: true allOf: - $ref: "#/components/schemas/DefaultValueString" functionInputVariableID: type: string captureType: allOf: - $ref: "#/components/schemas/ToolNodeCaptureType" required: type: boolean description: "Whether the agent must supply a value for this input. Omit it and the API infers: false when defaultValue holds a secret reference (the secret is injected and the model is never asked for it), true otherwise. Sending true together with a secret defaultValue is rejected." required: - functionInputVariableID - required description: A map of input names to the values the agent supplies when calling the tool. captureResponse: type: object additionalProperties: $ref: "#/components/schemas/ToolNodeDataFunctionCaptureResponse" description: A map of variable names to the parts of the tool response captured into them. required: - id - createdAt - updatedAt - messages - toolSound - description - captureInputVariables - type - functionID - asyncExecution - inputVariables - captureResponse - type: object properties: id: type: string createdAt: type: string format: date-time pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ updatedAt: type: string format: date-time pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ messages: nullable: true allOf: - $ref: "#/components/schemas/StableToolMessages" toolSound: nullable: true description: The sound played while the tool runs, as the editor sets it, or null for none. allOf: - $ref: "#/components/schemas/ToolNodeDataToolSound" description: nullable: true description: A description of what the tool does, used by the agent to decide when to call it. type: string captureInputVariables: nullable: true description: A map of tool input names to the variables or entities whose values are captured into them. type: object additionalProperties: $ref: "#/components/schemas/AgentToolCaptureInputVariable" type: type: string enum: - mcp description: Discriminator indicating this tool calls a tool from an MCP server. x-enumNames: - MCP mcpToolID: type: string description: The ID of the MCP tool resource this tool calls. inputVariables: type: object additionalProperties: type: object properties: description: default: null nullable: true type: string defaultValue: default: null nullable: true allOf: - $ref: "#/components/schemas/DefaultValueString" mcpIntegrationVariableName: type: string captureType: allOf: - $ref: "#/components/schemas/ToolNodeCaptureType" required: type: boolean description: "Whether the agent must supply a value for this input. Omit it and the API infers: false when defaultValue holds a secret reference (the secret is injected and the model is never asked for it), true otherwise. Sending true together with a secret defaultValue is rejected." required: - mcpIntegrationVariableName - required description: A map of input names to the values the agent supplies when calling the tool. captureResponse: type: object additionalProperties: $ref: "#/components/schemas/ToolNodeDataMcpIntegrationCaptureResponse" description: A map of variable names to the parts of the tool response captured into them. required: - id - createdAt - updatedAt - messages - toolSound - description - captureInputVariables - type - mcpToolID - inputVariables - captureResponse - type: object properties: id: type: string createdAt: type: string format: date-time pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ updatedAt: type: string format: date-time pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ messages: nullable: true allOf: - $ref: "#/components/schemas/StableToolMessages" toolSound: nullable: true description: The sound played while the tool runs, as the editor sets it, or null for none. allOf: - $ref: "#/components/schemas/ToolNodeDataToolSound" description: nullable: true description: A description of what the tool does, used by the agent to decide when to call it. type: string captureInputVariables: nullable: true description: A map of tool input names to the variables or entities whose values are captured into them. type: object additionalProperties: $ref: "#/components/schemas/AgentToolCaptureInputVariable" type: type: string enum: - integration description: Discriminator indicating this tool calls a connected first-party integration. x-enumNames: - INTEGRATION integrationToolID: type: string description: The ID of the integration tool resource this tool calls. inputVariables: type: object additionalProperties: type: object properties: description: default: null nullable: true type: string defaultValue: default: null nullable: true allOf: - $ref: "#/components/schemas/DefaultValueString" integrationToolVariableName: type: string captureType: allOf: - $ref: "#/components/schemas/ToolNodeCaptureType" required: type: boolean description: "Whether the agent must supply a value for this input. Omit it and the API infers: false when defaultValue holds a secret reference (the secret is injected and the model is never asked for it), true otherwise. Sending true together with a secret defaultValue is rejected." required: - integrationToolVariableName - required description: A map of input names to the values the agent supplies when calling the tool. captureResponse: type: object additionalProperties: $ref: "#/components/schemas/ToolNodeDataIntegrationCaptureResponse" description: A map of variable names to the parts of the tool response captured into them. extendedInputVariables: nullable: true description: The refined schema of nested inputs the editor stores for some integrations, keyed by input. Copy it as read; null when there is none. type: object additionalProperties: $ref: "#/components/schemas/ToolExtendedInputVariable" required: - id - createdAt - updatedAt - messages - toolSound - description - captureInputVariables - type - integrationToolID - inputVariables - captureResponse - extendedInputVariables StableToolMessages: type: object properties: generative: type: object properties: execution: allOf: - $ref: "#/components/schemas/StableToolMessageGenerative" failure: allOf: - $ref: "#/components/schemas/StableToolMessageGenerative" delay: allOf: - $ref: "#/components/schemas/StableToolMessageGenerative" completion: allOf: - $ref: "#/components/schemas/StableToolMessageGenerative" delayMessageID: nullable: true type: string failureMessageID: nullable: true type: string executionMessageID: nullable: true type: string completionMessageID: nullable: true type: string delayMessageSeconds: nullable: true type: number required: - delayMessageID - failureMessageID - executionMessageID - completionMessageID - delayMessageSeconds StableToolMessageGenerative: type: object properties: enabled: type: boolean examples: type: array items: $ref: "#/components/schemas/MarkdownLikeString" required: - enabled MarkdownLikeString: type: string description: "Message text shown to the end user. Limited markdown: **bold**, _italic_, underline, ~~strikethrough~~, [label](url). {variable_name} inserts a variable or entity, {variable_name.path} a field of a variable. Escape a literal { or \\ with a backslash. A name matching neither is stored as literal text and reported in unresolvedReferences; secrets are not available here." ToolNodeDataToolSound: type: object properties: ref: nullable: true type: string volume: default: 0.75 type: number minimum: 0 maximum: 1 required: - ref AgentToolCaptureInputVariable: type: object properties: variableOrEntityID: nullable: true type: string captureType: allOf: - $ref: "#/components/schemas/ToolNodeCaptureType" required: - variableOrEntityID ToolNodeCaptureType: type: string enum: - variable - property x-enumNames: - VARIABLE - PROPERTY DefaultValueString: type: string description: Plain text resolved at runtime and never shown to a model. {variable_name} inserts a variable or entity, {secret_name} a project secret, {variable_name.path} a field of a variable. Escape a literal { or \ with a backslash. When a name is both a variable and a secret, the secret wins. A name matching none is stored as literal text and reported in unresolvedReferences. Where the field is sent to an upstream system, an unresolved placeholder may be sent as literal text; on an MCP server it is re-resolved by name at connect time, so a literal that matches a real secret binds. ToolNodeDataAPICaptureResponse: type: object properties: path: type: string variableOrEntityID: nullable: true type: string captureType: allOf: - $ref: "#/components/schemas/ToolNodeCaptureType" required: - path - variableOrEntityID ToolNodeDataFunctionCaptureResponse: type: object properties: variableOrEntityID: nullable: true type: string functionOutputVariableID: type: string captureType: allOf: - $ref: "#/components/schemas/ToolNodeCaptureType" required: - variableOrEntityID - functionOutputVariableID ToolNodeDataMcpIntegrationCaptureResponse: type: object properties: path: type: string variableOrEntityID: nullable: true type: string captureType: allOf: - $ref: "#/components/schemas/ToolNodeCaptureType" required: - path - variableOrEntityID ToolNodeDataIntegrationCaptureResponse: type: object properties: path: type: string variableOrEntityID: nullable: true type: string captureType: allOf: - $ref: "#/components/schemas/ToolNodeCaptureType" required: - path - variableOrEntityID ToolExtendedInputVariable: type: object properties: schema: {} metadata: type: object additionalProperties: {} draft: allOf: - $ref: "#/components/schemas/ToolExtendedInputVariableSlot" ToolExtendedInputVariableSlot: type: object properties: schema: {} metadata: type: object additionalProperties: {} securitySchemes: token: scheme: bearer bearerFormat: JWT type: http description: Voiceflow bearer token ````