Voiceflow bearer token
Tools
Give your agent actions it can perform.
Paste in your agent
1. Set up Voiceflow by following https://www.voiceflow.com/agents/setup 2. Read https://www.voiceflow.com/docs/api-reference/resources/tool.md — the Voiceflow documentation page "Tools". Use it to help me with this part of Voiceflow and answer my questions. Refer to https://www.voiceflow.com/docs/llms.txt if you need related documentation.
See Authentication for credentials and permissions.
Legacy - 2026/07
/v1/stable/toolReturns every tool in the environment. A tool is something a playbook can call during a conversation. The call takes no paging parameters, so one request yields the whole set.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v1/stable/tool?global=<global>&playbookID=<playbookID>&projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/tool?global=<global>&playbookID=<playbookID>&projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/tool?global=<global>&playbookID=<playbookID>&projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf tool list --global <global> --playbook-id <playbookID> --project-id <projectID> --environment-alias <environmentAlias> --type <type>{
"tools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"messages": "<AgentToolMessages>",
"description": "<string>",
"captureInputVariables": {},
"type": "api",
"apiToolID": "<string>",
"asyncExecution": true,
"inputVariables": {},
"captureResponse": {}
}
]
}Authentication
Query parameters
Target the agent. Cannot be used with playbookID.
Target a specific playbook. Cannot be used with global.
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
When provided, only tools of this type are returned.
api, mcp, function, integrationResponse
200 - application/jsonReturns the tools attached to the agent or to a single playbook, depending on whether you pass global or playbookID. Each entry is the attachment rather than the underlying resource: it points at an API tool, function, or MCP tool by ID and carries the description, input mappings, and response capture used when the agent calls it.
Legacy - 2026/07
/v1/stable/toolAdds a tool to the environment, something a playbook can call during a conversation. The response carries the ID that later calls address it by.
curl --request POST \
--url 'https://realtime-api.voiceflow.com/v1/stable/tool?projectID=<projectID>&environmentAlias=<environmentAlias>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"target": {
"global": true,
"playbookID": "<string>"
},
"messages": null,
"captureInputVariables": {},
"asyncExecution": false,
"inputVariables": {},
"captureResponse": {},
"type": "api",
"apiToolID": "<string>"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/tool?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"description": "<string>",
"target": {
"global": true,
"playbookID": "<string>"
},
"messages": null,
"captureInputVariables": {},
"asyncExecution": false,
"inputVariables": {},
"captureResponse": {},
"type": "api",
"apiToolID": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/tool?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"description": "<string>",
"target": {
"global": True,
"playbookID": "<string>"
},
"messages": None,
"captureInputVariables": {},
"asyncExecution": False,
"inputVariables": {},
"captureResponse": {},
"type": "api",
"apiToolID": "<string>"
},
)
data = response.json()vf tool create --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
"description": "<string>",
"target": {
"global": true,
"playbookID": "<string>"
},
"messages": null,
"captureInputVariables": {},
"asyncExecution": false,
"inputVariables": {},
"captureResponse": {},
"type": "api",
"apiToolID": "<string>"
}
JSON{
"tool": {
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"messages": "<AgentToolMessages>",
"description": "<string>",
"captureInputVariables": {},
"type": "api",
"apiToolID": "<string>",
"asyncExecution": true,
"inputVariables": {},
"captureResponse": {}
}
}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
Show child attributes
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
Show child attributes
enabled, examplesenabled, examplesenabled, examplesenabled, examplesA map of tool input names to the variables or entities whose values are captured into them.
When enabled, the tool runs in the background without blocking the conversation.
A map of variable names to the parts of the tool response captured into them.
Discriminator indicating this tool executes a saved API request.
apiThe ID of the API resource this tool executes.
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
Show child attributes
enabled, examplesenabled, examplesenabled, examplesenabled, examplesA map of tool input names to the variables or entities whose values are captured into them.
When enabled, the tool runs in the background without blocking the conversation.
A map of variable names to the parts of the tool response captured into them.
Discriminator indicating this tool executes a custom function.
functionThe ID of the function resource this tool executes.
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
Show child attributes
enabled, examplesenabled, examplesenabled, examplesenabled, examplesA map of tool input names to the variables or entities whose values are captured into them.
A map of variable names to the parts of the tool response captured into them.
Discriminator indicating this tool calls a tool from an MCP server.
mcpThe ID of the MCP tool resource this tool calls.
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
Show child attributes
enabled, examplesenabled, examplesenabled, examplesenabled, examplesA map of tool input names to the variables or entities whose values are captured into them.
A map of variable names to the parts of the tool response captured into them.
Discriminator indicating this tool calls a connected first-party integration.
integrationThe ID of the integration tool resource this tool calls.
Response
201 - application/jsonAttaches 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.
Current - 2026/09
/v2/stable/toolReturns every tool in the environment, including workflow tools. A tool is something a playbook can call during a conversation. The call takes no paging parameters, so one request yields the whole set.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v2/stable/tool?global=<global>&playbookID=<playbookID>&projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/tool?global=<global>&playbookID=<playbookID>&projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v2/stable/tool?global=<global>&playbookID=<playbookID>&projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf tool list --global <global> --playbook-id <playbookID> --project-id <projectID> --environment-alias <environmentAlias> --type <type>{
"tools": [
{
"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": {}
}
]
}Authentication
Voiceflow bearer token
Query parameters
Target the agent. Cannot be used with playbookID.
Target a specific playbook. Cannot be used with global.
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
When provided, only tools of this type are returned. workflow returns the workflow tools.
api, mcp, function, integration, workflowResponse
200 - application/jsonReturns the tools attached to the agent or to a single playbook, depending on whether you pass global or playbookID. Each entry is the attachment rather than the underlying resource: it points at an API tool, function, MCP tool, integration tool or workflow by ID and carries the description, input mappings, and response capture used when the agent calls it.
Current - 2026/09
/v2/stable/toolAdds a tool to the environment, or gives the agent a workflow tool. A tool is something a playbook can call during a conversation. Message text and default input values are plain strings, and the response carries the ID that later calls address it by.
curl --request POST \
--url 'https://realtime-api.voiceflow.com/v2/stable/tool?projectID=<projectID>&environmentAlias=<environmentAlias>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"target": {
"global": true,
"playbookID": "<string>"
},
"messages": null,
"captureInputVariables": {},
"toolSound": null,
"asyncExecution": false,
"inputVariables": {},
"captureResponse": {},
"type": "api",
"apiToolID": "<string>"
}'const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/tool?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"description": "<string>",
"target": {
"global": true,
"playbookID": "<string>"
},
"messages": null,
"captureInputVariables": {},
"toolSound": null,
"asyncExecution": false,
"inputVariables": {},
"captureResponse": {},
"type": "api",
"apiToolID": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v2/stable/tool?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"description": "<string>",
"target": {
"global": True,
"playbookID": "<string>"
},
"messages": None,
"captureInputVariables": {},
"toolSound": None,
"asyncExecution": False,
"inputVariables": {},
"captureResponse": {},
"type": "api",
"apiToolID": "<string>"
},
)
data = response.json()vf tool create --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
"description": "<string>",
"target": {
"global": true,
"playbookID": "<string>"
},
"messages": null,
"captureInputVariables": {},
"toolSound": null,
"asyncExecution": false,
"inputVariables": {},
"captureResponse": {},
"type": "api",
"apiToolID": "<string>"
}
JSON{
"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": {}
},
"unresolvedReferences": [
{
"path": "<string>",
"token": "<string>",
"reason": "unknown"
}
]
}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
Show child attributes
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
Show child attributes
enabled, examplesenabled, examplesenabled, examplesenabled, examplesA map of tool input names to the variables or entities whose values are captured into them.
The sound played while the tool runs, as the editor sets it, or null for none.
Show child attributes
When enabled, the tool runs in the background without blocking the conversation.
A map of variable names to the parts of the tool response captured into them.
Discriminator indicating this tool executes a saved API request.
apiThe ID of the API resource this tool executes.
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
Show child attributes
enabled, examplesenabled, examplesenabled, examplesenabled, examplesA map of tool input names to the variables or entities whose values are captured into them.
The sound played while the tool runs, as the editor sets it, or null for none.
Show child attributes
When enabled, the tool runs in the background without blocking the conversation.
A map of variable names to the parts of the tool response captured into them.
Discriminator indicating this tool executes a custom function.
functionThe ID of the function resource this tool executes.
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
Show child attributes
enabled, examplesenabled, examplesenabled, examplesenabled, examplesA map of tool input names to the variables or entities whose values are captured into them.
The sound played while the tool runs, as the editor sets it, or null for none.
Show child attributes
A map of variable names to the parts of the tool response captured into them.
Discriminator indicating this tool calls a tool from an MCP server.
mcpThe ID of the MCP tool resource this tool calls.
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
Show child attributes
enabled, examplesenabled, examplesenabled, examplesenabled, examplesA map of tool input names to the variables or entities whose values are captured into them.
The sound played while the tool runs, as the editor sets it, or null for none.
Show child attributes
A map of variable names to the parts of the tool response captured into them.
The refined schema of nested inputs the editor stores for some integrations, keyed by input. Copy it as read; null when there is none.
Discriminator indicating this tool calls a connected first-party integration.
integrationThe ID of the integration tool resource this tool calls.
Show child attributes
Give the agent a tool that runs a workflow. Send target: { global: true }; playbooks take none.
workflowThe workflow to attach, from voiceflow_workflow.list.
When the agent should run the workflow. Omit it to use the workflow's own description.
The variables or entities the model must fill when it calls the tool. Leave it out for none.
Response
201 - application/jsonAttaches an existing API tool, function, MCP tool, integration tool or workflow 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.
References this write kept as literal text instead of binding, each with the reason. The write still succeeded.
Legacy - 2026/07
/v1/stable/tool/batchAdds several tools to the environment in one request, each taking the fields the single-create call takes. The response carries the created tools in the same shape the list call returns.
curl --request POST \
--url 'https://realtime-api.voiceflow.com/v1/stable/tool/batch?projectID=<projectID>&environmentAlias=<environmentAlias>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"type": "api",
"target": {
"global": true,
"playbookID": "<string>"
},
"tools": [
{
"description": "<string>",
"messages": null,
"captureInputVariables": {},
"asyncExecution": false,
"inputVariables": {},
"captureResponse": {},
"apiToolID": "<string>"
}
]
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/tool/batch?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"type": "api",
"target": {
"global": true,
"playbookID": "<string>"
},
"tools": [
{
"description": "<string>",
"messages": null,
"captureInputVariables": {},
"asyncExecution": false,
"inputVariables": {},
"captureResponse": {},
"apiToolID": "<string>"
}
]
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/tool/batch?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"type": "api",
"target": {
"global": True,
"playbookID": "<string>"
},
"tools": [
{
"description": "<string>",
"messages": None,
"captureInputVariables": {},
"asyncExecution": False,
"inputVariables": {},
"captureResponse": {},
"apiToolID": "<string>"
}
]
},
)
data = response.json()vf tool create-many --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
"type": "api",
"target": {
"global": true,
"playbookID": "<string>"
},
"tools": [
{
"description": "<string>",
"messages": null,
"captureInputVariables": {},
"asyncExecution": false,
"inputVariables": {},
"captureResponse": {},
"apiToolID": "<string>"
}
]
}
JSON{
"tools": [
{
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"messages": "<AgentToolMessages>",
"description": "<string>",
"captureInputVariables": {},
"type": "api",
"apiToolID": "<string>",
"asyncExecution": true,
"inputVariables": {},
"captureResponse": {}
}
]
}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
Show child attributes
Show child attributes
Discriminator indicating that API tools are being created.
apiShow child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
delay, failure, execution, completionA map of tool input names to the variables or entities whose values are captured into them.
When enabled, the tool runs in the background without blocking the conversation.
A map of variable names to the parts of the tool response captured into them.
The ID of the API resource this tool executes.
Show child attributes
Discriminator indicating that function tools are being created.
functionShow child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
delay, failure, execution, completionA map of tool input names to the variables or entities whose values are captured into them.
When enabled, the tool runs in the background without blocking the conversation.
A map of variable names to the parts of the tool response captured into them.
The ID of the function resource this tool executes.
Show child attributes
Discriminator indicating that MCP tools are being created.
mcpShow child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
delay, failure, execution, completionA map of tool input names to the variables or entities whose values are captured into them.
A map of variable names to the parts of the tool response captured into them.
The ID of the MCP tool resource this tool calls.
Show child attributes
Discriminator indicating that integration tools are being created.
integrationShow child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
delay, failure, execution, completionA map of tool input names to the variables or entities whose values are captured into them.
A map of variable names to the parts of the tool response captured into them.
The ID of the integration tool resource this tool calls.
Response
201 - application/jsonAttaches several tools to the same target in one call and returns each attachment with its generated ID. The request carries a single type and a single target, so tools of different types need separate calls.
Current - 2026/09
/v2/stable/tool/batchAdds several tools to the environment in one request, each taking the fields the single-create call takes, with message text and default input values as plain strings. The response carries the created tools in the same shape the list call returns.
curl --request POST \
--url 'https://realtime-api.voiceflow.com/v2/stable/tool/batch?projectID=<projectID>&environmentAlias=<environmentAlias>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"type": "api",
"target": {
"global": true,
"playbookID": "<string>"
},
"tools": [
{
"description": "<string>",
"messages": null,
"captureInputVariables": {},
"toolSound": null,
"asyncExecution": false,
"inputVariables": {},
"captureResponse": {},
"apiToolID": "<string>"
}
]
}'const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/tool/batch?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"type": "api",
"target": {
"global": true,
"playbookID": "<string>"
},
"tools": [
{
"description": "<string>",
"messages": null,
"captureInputVariables": {},
"toolSound": null,
"asyncExecution": false,
"inputVariables": {},
"captureResponse": {},
"apiToolID": "<string>"
}
]
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v2/stable/tool/batch?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"type": "api",
"target": {
"global": True,
"playbookID": "<string>"
},
"tools": [
{
"description": "<string>",
"messages": None,
"captureInputVariables": {},
"toolSound": None,
"asyncExecution": False,
"inputVariables": {},
"captureResponse": {},
"apiToolID": "<string>"
}
]
},
)
data = response.json()vf tool create-many --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
"type": "api",
"target": {
"global": true,
"playbookID": "<string>"
},
"tools": [
{
"description": "<string>",
"messages": null,
"captureInputVariables": {},
"toolSound": null,
"asyncExecution": false,
"inputVariables": {},
"captureResponse": {},
"apiToolID": "<string>"
}
]
}
JSON{
"tools": [
{
"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": {}
}
],
"unresolvedReferences": [
{
"path": "<string>",
"token": "<string>",
"reason": "unknown"
}
]
}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
Show child attributes
Show child attributes
Discriminator indicating that API tools are being created.
apiShow child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
execution, failure, delay, completionA map of tool input names to the variables or entities whose values are captured into them.
The sound played while the tool runs, as the editor sets it, or null for none.
Show child attributes
When enabled, the tool runs in the background without blocking the conversation.
A map of variable names to the parts of the tool response captured into them.
The ID of the API resource this tool executes.
Show child attributes
Discriminator indicating that function tools are being created.
functionShow child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
execution, failure, delay, completionA map of tool input names to the variables or entities whose values are captured into them.
The sound played while the tool runs, as the editor sets it, or null for none.
Show child attributes
When enabled, the tool runs in the background without blocking the conversation.
A map of variable names to the parts of the tool response captured into them.
The ID of the function resource this tool executes.
Show child attributes
Discriminator indicating that MCP tools are being created.
mcpShow child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
execution, failure, delay, completionA map of tool input names to the variables or entities whose values are captured into them.
The sound played while the tool runs, as the editor sets it, or null for none.
Show child attributes
A map of variable names to the parts of the tool response captured into them.
The ID of the MCP tool resource this tool calls.
Show child attributes
Discriminator indicating that integration tools are being created.
integrationShow child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
execution, failure, delay, completionA map of tool input names to the variables or entities whose values are captured into them.
The sound played while the tool runs, as the editor sets it, or null for none.
Show child attributes
A map of variable names to the parts of the tool response captured into them.
The refined schema of nested inputs the editor stores for some integrations, keyed by input. Copy it as read; null when there is none.
The ID of the integration tool resource this tool calls.
Response
201 - application/jsonAttaches several tools to the same target in one call and returns each attachment with its generated ID. The request carries a single type and a single target, so tools of different types need separate calls.
References this write kept as literal text instead of binding, each with the reason. The write still succeeded.
Legacy - 2026/07
/v1/stable/tool/{toolID}Returns a single tool by ID, with the fields that define it. A tool is something a playbook can call during a conversation.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v1/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf tool get --tool-id <toolID> --project-id <projectID> --environment-alias <environmentAlias> --type <type>{
"tool": {
"id": "<string>",
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"messages": "<AgentToolMessages>",
"description": "<string>",
"captureInputVariables": {},
"type": "api",
"apiToolID": "<string>",
"asyncExecution": true,
"inputVariables": {},
"captureResponse": {}
}
}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).
The type of the tool to fetch.
api, mcp, function, integrationResponse
200 - application/jsonReturns one attached tool with the resource it points at, the description the agent reads, its input mappings, and where its response is captured. The required type parameter selects which of the three shapes, API, function, or MCP, comes back.
Legacy - 2026/07
/v1/stable/tool/{toolID}Changes an existing tool in place. The response carries only a confirmation message, so refetch the tool to read its new values.
curl --request PATCH \
--url 'https://realtime-api.voiceflow.com/v1/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"captureInputVariables": {},
"type": "api",
"asyncExecution": true,
"inputVariables": {},
"captureResponse": {}
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"description": "<string>",
"captureInputVariables": {},
"type": "api",
"asyncExecution": true,
"inputVariables": {},
"captureResponse": {}
}),
});
const data = await response.json();import requests
response = requests.patch(
'https://realtime-api.voiceflow.com/v1/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"description": "<string>",
"captureInputVariables": {},
"type": "api",
"asyncExecution": True,
"inputVariables": {},
"captureResponse": {}
},
)
data = response.json()vf tool update --tool-id <toolID> --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
"description": "<string>",
"captureInputVariables": {},
"type": "api",
"asyncExecution": true,
"inputVariables": {},
"captureResponse": {}
}
JSON{
"message": "<string>"
}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
Show child attributes
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
A map of tool input names to the variables or entities whose values are captured into them.
Discriminator indicating this tool executes a saved API request.
apiWhen enabled, the tool runs in the background without blocking the conversation.
A map of variable names to the parts of the tool response captured into them.
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
A map of tool input names to the variables or entities whose values are captured into them.
Discriminator indicating this tool executes a custom function.
functionWhen enabled, the tool runs in the background without blocking the conversation.
A map of variable names to the parts of the tool response captured into them.
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
A map of tool input names to the variables or entities whose values are captured into them.
Discriminator indicating this tool calls a tool from an MCP server.
mcpA map of variable names to the parts of the tool response captured into them.
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
A map of tool input names to the variables or entities whose values are captured into them.
Discriminator indicating this tool calls a connected first-party integration.
integrationA map of variable names to the parts of the tool response captured into them.
Response
200 - application/jsonConfirms the attachment's wiring was updated, meaning its description, input mappings, or capture settings rather than the API tool, function, or MCP tool it points at. The body is a message only, so refetch the tool to read its current state.
A human-readable message confirming the update.
Legacy - 2026/07
/v1/stable/tool/{toolID}Deletes a single tool by ID. A tool is something a playbook can call during a conversation. The response carries only a confirmation message, so refetch the tools to see what is left.
curl --request DELETE \
--url 'https://realtime-api.voiceflow.com/v1/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>', {
method: 'DELETE',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.delete(
'https://realtime-api.voiceflow.com/v1/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf tool delete --tool-id <toolID> --project-id <projectID> --environment-alias <environmentAlias> --type <type>{
"message": "<string>"
}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).
The type of the tool to delete.
api, mcp, function, integrationResponse
200 - application/jsonConfirms the tool attachment was removed, and the required type parameter must match the type of the tool being deleted. The body is a message only, so refetch the agent's or playbook's tools to see what it can still call.
A human-readable message confirming the deletion.
Current - 2026/09
/v2/stable/tool/{toolID}Returns a single tool by ID, including a workflow tool, with the fields that define it. A tool is something a playbook can call during a conversation.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v2/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v2/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf tool get --tool-id <toolID> --project-id <projectID> --environment-alias <environmentAlias> --type <type>{
"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": {}
}
}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).
The type of the tool to fetch.
api, mcp, function, integration, workflowResponse
200 - application/jsonReturns one attached tool with the resource it points at, the description the agent reads, its input mappings, and where its response is captured. The required type parameter selects which of the five shapes, API, function, MCP, integration or workflow, comes back.
Current - 2026/09
/v2/stable/tool/{toolID}Changes an existing tool attachment in place, taking message text and default input values as plain strings. The response lists any references that did not resolve; read the tool again to see its new values.
curl --request PATCH \
--url 'https://realtime-api.voiceflow.com/v2/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"messages": {
"generative": {
"execution": "<StableToolMessageGenerative>",
"failure": "<StableToolMessageGenerative>",
"delay": "<StableToolMessageGenerative>",
"completion": "<StableToolMessageGenerative>"
},
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 0
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
},
"captureInputVariables": {},
"type": "api",
"asyncExecution": true,
"inputVariables": {},
"captureResponse": {}
}'const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"description": "<string>",
"messages": {
"generative": {
"execution": "<StableToolMessageGenerative>",
"failure": "<StableToolMessageGenerative>",
"delay": "<StableToolMessageGenerative>",
"completion": "<StableToolMessageGenerative>"
},
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 0
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
},
"captureInputVariables": {},
"type": "api",
"asyncExecution": true,
"inputVariables": {},
"captureResponse": {}
}),
});
const data = await response.json();import requests
response = requests.patch(
'https://realtime-api.voiceflow.com/v2/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"description": "<string>",
"messages": {
"generative": {
"execution": "<StableToolMessageGenerative>",
"failure": "<StableToolMessageGenerative>",
"delay": "<StableToolMessageGenerative>",
"completion": "<StableToolMessageGenerative>"
},
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 0
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
},
"captureInputVariables": {},
"type": "api",
"asyncExecution": True,
"inputVariables": {},
"captureResponse": {}
},
)
data = response.json()vf tool update --tool-id <toolID> --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
"description": "<string>",
"messages": {
"generative": {
"execution": "<StableToolMessageGenerative>",
"failure": "<StableToolMessageGenerative>",
"delay": "<StableToolMessageGenerative>",
"completion": "<StableToolMessageGenerative>"
},
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 0
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
},
"captureInputVariables": {},
"type": "api",
"asyncExecution": true,
"inputVariables": {},
"captureResponse": {}
}
JSON{
"message": "<string>",
"unresolvedReferences": [
{
"path": "<string>",
"token": "<string>",
"reason": "unknown"
}
]
}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
Show child attributes
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
Show child attributes
enabled, examplesenabled, examplesenabled, examplesenabled, examplesThe sound played while the tool runs. Replaces the stored one; null removes it; leave it out to keep it.
Show child attributes
A map of tool input names to the variables or entities whose values are captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed. Null for the whole map removes every entry.
Discriminator indicating this tool executes a saved API request.
apiWhen enabled, the tool runs in the background without blocking the conversation.
A map of input names to the values the agent supplies when calling the tool. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.
A map of variable names to the parts of the tool response captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
Show child attributes
enabled, examplesenabled, examplesenabled, examplesenabled, examplesThe sound played while the tool runs. Replaces the stored one; null removes it; leave it out to keep it.
Show child attributes
A map of tool input names to the variables or entities whose values are captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed. Null for the whole map removes every entry.
Discriminator indicating this tool executes a custom function.
functionWhen enabled, the tool runs in the background without blocking the conversation.
A map of input names to the values the agent supplies when calling the tool. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.
A map of variable names to the parts of the tool response captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
Show child attributes
enabled, examplesenabled, examplesenabled, examplesenabled, examplesThe sound played while the tool runs. Replaces the stored one; null removes it; leave it out to keep it.
Show child attributes
A map of tool input names to the variables or entities whose values are captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed. Null for the whole map removes every entry.
Discriminator indicating this tool calls a tool from an MCP server.
mcpA map of input names to the values the agent supplies when calling the tool. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.
A map of variable names to the parts of the tool response captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.
Show child attributes
A description of what the tool does, used by the agent to decide when to call it.
Show child attributes
Show child attributes
enabled, examplesenabled, examplesenabled, examplesenabled, examplesThe sound played while the tool runs. Replaces the stored one; null removes it; leave it out to keep it.
Show child attributes
A map of tool input names to the variables or entities whose values are captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed. Null for the whole map removes every entry.
Discriminator indicating this tool calls a connected first-party integration.
integrationA map of input names to the values the agent supplies when calling the tool. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.
A map of variable names to the parts of the tool response captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.
Replaces the stored map whole; null removes it; leave it out to keep it.
Response
200 - application/jsonConfirms the attachment's wiring was updated, meaning its description, input mappings, or capture settings rather than the API tool, function, or MCP tool it points at. The body is a message only, so refetch the tool to read its current state.
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.
Current - 2026/10
/v2/stable/tool/{toolID}Deletes a single tool by ID, including a workflow tool. A tool is something a playbook can call during a conversation. The response carries only a confirmation message, so refetch the tools to see what is left.
curl --request DELETE \
--url 'https://realtime-api.voiceflow.com/v2/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v2/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>', {
method: 'DELETE',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.delete(
'https://realtime-api.voiceflow.com/v2/stable/tool/<toolID>?projectID=<projectID>&environmentAlias=<environmentAlias>&type=<type>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf tool delete --tool-id <toolID> --project-id <projectID> --environment-alias <environmentAlias> --type <type>{
"message": "<string>"
}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).
The type of the tool to delete. workflow removes a workflow tool; the workflow stays.
api, mcp, function, integration, workflowResponse
200 - application/jsonConfirms the tool was deleted. The body is a message only, so refetch the agent's or playbook's tools to see what it can still call.
A human-readable message confirming the deletion.
/v1/stable/tool/{toolID}/moveMove a tool attachment to the agent or to a playbook. It keeps its ID, its fields and its messages.
curl --request POST \
--url 'https://realtime-api.voiceflow.com/v1/stable/tool/<toolID>/move?projectID=<projectID>&environmentAlias=<environmentAlias>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"type": "api",
"target": {
"global": true,
"playbookID": "<string>"
}
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/tool/<toolID>/move?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"type": "api",
"target": {
"global": true,
"playbookID": "<string>"
}
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/tool/<toolID>/move?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"type": "api",
"target": {
"global": True,
"playbookID": "<string>"
}
},
)
data = response.json()vf tool move --tool-id <toolID> --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
"type": "api",
"target": {
"global": true,
"playbookID": "<string>"
}
}
JSON{
"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": {}
}
}Authentication
Voiceflow bearer token
Path parameters
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The type of the tool to move. workflow is refused: a workflow tool stays on the agent.
api, mcp, function, integration, workflowResponse
200 - application/jsonSchemas
AgentToolCaptureInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
variableOrEntityID · required | {"nullable":true,"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
AgentToolMessages
{"type":"object"}
| Property | Definition |
|---|---|
generative | {"type":"object","properties":{"delay":{"allOf":[{"$ref":"ToolMessageGenerative"}]},"failure":{"allOf":[{"$ref":"ToolMessageGenerative"}]},"execution":{"allOf":[{"$ref":"ToolMessageGenerative"}]},"completion":{"allOf":[{"$ref":"ToolMessageGenerative"}]}}} |
delayMessageID · required | {"nullable":true,"type":"string"} |
failureMessageID · required | {"nullable":true,"type":"string"} |
executionMessageID · required | {"nullable":true,"type":"string"} |
completionMessageID · required | {"nullable":true,"type":"string"} |
delayMessageSeconds · required | {"nullable":true,"type":"number"} |
DefaultValueString
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.
{"type":"string"}
MarkdownLikeString
Message text shown to the end user. Limited markdown: bold, _italic_, <u>underline</u>, ~~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.
{"type":"string"}
Markup
{"type":"array","items":{"anyOf":[{"type":"string"},{"$ref":"MarkupSpan"},{"$ref":"MarkupToolReference"},{"$ref":"MarkupSecretReference"},{"$ref":"MarkupEntityReference"},{"$ref":"MarkupVariableReference"}]}}
MarkupEntityReference
{"type":"object"}
| Property | Definition |
|---|---|
entityID · required | {"type":"string"} |
MarkupSecretReference
{"type":"object"}
| Property | Definition |
|---|---|
secretID · required | {"type":"string"} |
MarkupSpan
{"type":"object"}
| Property | Definition |
|---|---|
text · required | {"$ref":"Markup"} |
attributes | {"type":"object","additionalProperties":{}} |
MarkupToolReference
{"type":"object"}
| Property | Definition |
|---|---|
resourceID · required | {"type":"string"} |
referenceType · required | {"$ref":"MarkupToolReferenceType"} |
MarkupToolReferenceType
{"type":"string","enum":["function","api-call","integration","mcp-integration","flow","agent","path-tool","system-tool"],"x-enumNames":["FUNCTION","API_CALL","INTEGRATION","MCP_INTEGRATION","FLOW","AGENT","PATH_TOOL","SYSTEM_TOOL"]}
MarkupVariableReference
{"type":"object"}
| Property | Definition |
|---|---|
variableID · required | {"type":"string"} |
path | {"type":"string"} |
StableDeleteResponse
{"type":"object"}
| Property | Definition |
|---|---|
message · required | A human-readable message confirming the deletion. {"type":"string"} |
StableRequiredVariable
{"type":"object"}
| Property | Definition |
|---|---|
variableOrEntityID · required | The ID of the variable or entity the model must fill, or null when the stored row names neither. {"nullable":true,"type":"string"} |
description · required | What the model is told to collect, or null. {"nullable":true,"type":"string"} |
StableRequiredVariableInput
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
variableOrEntityID · required | The ID of a variable or an entity in this environment. List each one once. {"type":"string","minLength":1} |
description | What the model is told to collect. Leave it out for none. {"default":null,"nullable":true,"type":"string"} |
StableTextUpdateResponse
{"type":"object"}
| Property | Definition |
|---|---|
message · required | A human-readable message confirming the update. {"type":"string"} |
unresolvedReferences | References this write kept as literal text instead of binding, each with the reason. The write still succeeded. {"type":"array","items":{"$ref":"StableUnresolvedReference"}} |
StableTool
{"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":"AgentToolMessages"}]},"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":"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":"Markup"}]},"apiToolInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"ToolNodeDataAPICaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."}},"required":["id","createdAt","updatedAt","messages","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":"AgentToolMessages"}]},"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":"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":"Markup"}]},"functionInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"ToolNodeDataFunctionCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."}},"required":["id","createdAt","updatedAt","messages","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":"AgentToolMessages"}]},"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":"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":"Markup"}]},"mcpIntegrationVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"ToolNodeDataMcpIntegrationCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."}},"required":["id","createdAt","updatedAt","messages","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":"AgentToolMessages"}]},"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":"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":"Markup"}]},"integrationToolVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"ToolNodeDataIntegrationCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."}},"required":["id","createdAt","updatedAt","messages","description","captureInputVariables","type","integrationToolID","inputVariables","captureResponse"]}]}
StableToolAttachmentV2
{"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":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"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":"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":"DefaultValueString"}]},"apiToolInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"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":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"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":"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":"DefaultValueString"}]},"functionInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"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":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"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":"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":"DefaultValueString"}]},"mcpIntegrationVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"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":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"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":"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":"DefaultValueString"}]},"integrationToolVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"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":"ToolExtendedInputVariable"}}},"required":["id","createdAt","updatedAt","messages","toolSound","description","captureInputVariables","type","integrationToolID","inputVariables","captureResponse","extendedInputVariables"]},{"$ref":"StableWorkflowTool"}]}
StableToolCreateManyRequest
{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["api"],"description":"Discriminator indicating that API tools are being created.","x-enumNames":["API"]},"target":{"$ref":"StableToolTarget"},"tools":{"type":"array","items":{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"asyncExecution":{"default":false,"description":"When enabled, the tool runs in the background without blocking the conversation.","type":"boolean"},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]},"apiToolInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataAPICaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"apiToolID":{"type":"string","description":"The ID of the API resource this tool executes."}},"required":["apiToolID"],"additionalProperties":false}}},"required":["type","target","tools"]},{"type":"object","properties":{"type":{"type":"string","enum":["function"],"description":"Discriminator indicating that function tools are being created.","x-enumNames":["FUNCTION"]},"target":{"$ref":"StableToolTarget"},"tools":{"type":"array","items":{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"asyncExecution":{"default":false,"description":"When enabled, the tool runs in the background without blocking the conversation.","type":"boolean"},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]},"functionInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataFunctionCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"functionID":{"type":"string","description":"The ID of the function resource this tool executes."}},"required":["functionID"],"additionalProperties":false}}},"required":["type","target","tools"]},{"type":"object","properties":{"type":{"type":"string","enum":["mcp"],"description":"Discriminator indicating that MCP tools are being created.","x-enumNames":["MCP"]},"target":{"$ref":"StableToolTarget"},"tools":{"type":"array","items":{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]},"mcpIntegrationVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataMcpIntegrationCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"mcpToolID":{"type":"string","description":"The ID of the MCP tool resource this tool calls."}},"required":["mcpToolID"],"additionalProperties":false}}},"required":["type","target","tools"]},{"type":"object","properties":{"type":{"type":"string","enum":["integration"],"description":"Discriminator indicating that integration tools are being created.","x-enumNames":["INTEGRATION"]},"target":{"$ref":"StableToolTarget"},"tools":{"type":"array","items":{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]},"integrationToolVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataIntegrationCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"integrationToolID":{"type":"string","description":"The ID of the integration tool resource this tool calls."}},"required":["integrationToolID"],"additionalProperties":false}}},"required":["type","target","tools"]}]}
StableToolCreateManyRequestV2
{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["api"],"description":"Discriminator indicating that API tools are being created.","x-enumNames":["API"]},"target":{"$ref":"StableToolTarget"},"tools":{"type":"array","items":{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"StableToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"toolSound":{"default":null,"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"ToolNodeDataToolSound"}]},"asyncExecution":{"default":false,"description":"When enabled, the tool runs in the background without blocking the conversation.","type":"boolean"},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"DefaultValueString"}]},"apiToolInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataAPICaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"apiToolID":{"type":"string","description":"The ID of the API resource this tool executes."}},"required":["apiToolID"],"additionalProperties":false}}},"required":["type","target","tools"]},{"type":"object","properties":{"type":{"type":"string","enum":["function"],"description":"Discriminator indicating that function tools are being created.","x-enumNames":["FUNCTION"]},"target":{"$ref":"StableToolTarget"},"tools":{"type":"array","items":{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"StableToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"toolSound":{"default":null,"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"ToolNodeDataToolSound"}]},"asyncExecution":{"default":false,"description":"When enabled, the tool runs in the background without blocking the conversation.","type":"boolean"},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"DefaultValueString"}]},"functionInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataFunctionCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"functionID":{"type":"string","description":"The ID of the function resource this tool executes."}},"required":["functionID"],"additionalProperties":false}}},"required":["type","target","tools"]},{"type":"object","properties":{"type":{"type":"string","enum":["mcp"],"description":"Discriminator indicating that MCP tools are being created.","x-enumNames":["MCP"]},"target":{"$ref":"StableToolTarget"},"tools":{"type":"array","items":{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"StableToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"toolSound":{"default":null,"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"ToolNodeDataToolSound"}]},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"DefaultValueString"}]},"mcpIntegrationVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataMcpIntegrationCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"mcpToolID":{"type":"string","description":"The ID of the MCP tool resource this tool calls."}},"required":["mcpToolID"],"additionalProperties":false}}},"required":["type","target","tools"]},{"type":"object","properties":{"type":{"type":"string","enum":["integration"],"description":"Discriminator indicating that integration tools are being created.","x-enumNames":["INTEGRATION"]},"target":{"$ref":"StableToolTarget"},"tools":{"type":"array","items":{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"StableToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"toolSound":{"default":null,"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"ToolNodeDataToolSound"}]},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"DefaultValueString"}]},"integrationToolVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataIntegrationCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"extendedInputVariables":{"default":null,"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":"ToolExtendedInputVariable"}},"integrationToolID":{"type":"string","description":"The ID of the integration tool resource this tool calls."}},"required":["integrationToolID"],"additionalProperties":false}}},"required":["type","target","tools"]}]}
StableToolCreateManyResponse
{"type":"object"}
| Property | Definition |
|---|---|
tools · required | {"type":"array","items":{"$ref":"StableToolV2"}} |
unresolvedReferences | References this write kept as literal text instead of binding, each with the reason. The write still succeeded. {"type":"array","items":{"$ref":"StableUnresolvedReference"}} |
StableToolCreateRequest
{"oneOf":[{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"target":{"$ref":"StableToolTarget"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"asyncExecution":{"default":false,"description":"When enabled, the tool runs in the background without blocking the conversation.","type":"boolean"},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]},"apiToolInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataAPICaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"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."}},"required":["target","type","apiToolID"],"additionalProperties":false},{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"target":{"$ref":"StableToolTarget"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"asyncExecution":{"default":false,"description":"When enabled, the tool runs in the background without blocking the conversation.","type":"boolean"},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]},"functionInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataFunctionCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"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."}},"required":["target","type","functionID"],"additionalProperties":false},{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"target":{"$ref":"StableToolTarget"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]},"mcpIntegrationVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataMcpIntegrationCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"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."}},"required":["target","type","mcpToolID"],"additionalProperties":false},{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"target":{"$ref":"StableToolTarget"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"AgentToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]},"integrationToolVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataIntegrationCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"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."}},"required":["target","type","integrationToolID"],"additionalProperties":false}]}
StableToolCreateRequestV2
{"oneOf":[{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"target":{"$ref":"StableToolTarget"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"StableToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"toolSound":{"default":null,"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"ToolNodeDataToolSound"}]},"asyncExecution":{"default":false,"description":"When enabled, the tool runs in the background without blocking the conversation.","type":"boolean"},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"DefaultValueString"}]},"apiToolInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataAPICaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"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."}},"required":["target","type","apiToolID"],"additionalProperties":false},{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"target":{"$ref":"StableToolTarget"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"StableToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"toolSound":{"default":null,"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"ToolNodeDataToolSound"}]},"asyncExecution":{"default":false,"description":"When enabled, the tool runs in the background without blocking the conversation.","type":"boolean"},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"DefaultValueString"}]},"functionInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataFunctionCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"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."}},"required":["target","type","functionID"],"additionalProperties":false},{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"target":{"$ref":"StableToolTarget"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"StableToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"toolSound":{"default":null,"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"ToolNodeDataToolSound"}]},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"DefaultValueString"}]},"mcpIntegrationVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataMcpIntegrationCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"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."}},"required":["target","type","mcpToolID"],"additionalProperties":false},{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"target":{"$ref":"StableToolTarget"},"messages":{"default":null,"nullable":true,"allOf":[{"$ref":"StableToolMessages"}]},"captureInputVariables":{"default":{},"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them.","type":"object","additionalProperties":{"$ref":"AgentToolCaptureInputVariable"}},"toolSound":{"default":null,"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"ToolNodeDataToolSound"}]},"inputVariables":{"default":{},"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"DefaultValueString"}]},"integrationToolVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"default":{},"type":"object","additionalProperties":{"$ref":"ToolNodeDataIntegrationCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."},"extendedInputVariables":{"default":null,"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":"ToolExtendedInputVariable"}},"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."}},"required":["target","type","integrationToolID"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["workflow"],"description":"Give the agent a tool that runs a workflow. Send target: { global: true }; playbooks take none.","x-enumNames":["WORKFLOW"]},"target":{"$ref":"StableToolTarget"},"workflowID":{"type":"string","description":"The workflow to attach, from voiceflow_workflow.list."},"description":{"description":"When the agent should run the workflow. Omit it to use the workflow's own description.","nullable":true,"type":"string"},"requiredVariables":{"default":[],"description":"The variables or entities the model must fill when it calls the tool. Leave it out for none.","type":"array","items":{"$ref":"StableRequiredVariableInput"}}},"required":["type","target","workflowID"],"additionalProperties":false}]}
StableToolListItemV2
{"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":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"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":"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":"DefaultValueString"}]},"apiToolInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"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":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"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":"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":"DefaultValueString"}]},"functionInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"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":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"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":"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":"DefaultValueString"}]},"mcpIntegrationVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"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":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"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":"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":"DefaultValueString"}]},"integrationToolVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"ToolNodeDataIntegrationCaptureResponse"},"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","integrationToolID","inputVariables","captureResponse"]},{"$ref":"StableWorkflowTool"}]}
StableToolListResponse
{"type":"object"}
| Property | Definition |
|---|---|
tools · required | {"type":"array","items":{"$ref":"StableTool"}} |
StableToolListResponseV2
{"type":"object"}
| Property | Definition |
|---|---|
tools · required | {"type":"array","items":{"$ref":"StableToolListItemV2"}} |
StableToolMessageGenerative
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
examples | {"type":"array","items":{"$ref":"MarkdownLikeString"}} |
StableToolMessages
{"type":"object"}
| Property | Definition |
|---|---|
generative | {"type":"object","properties":{"execution":{"allOf":[{"$ref":"StableToolMessageGenerative"}]},"failure":{"allOf":[{"$ref":"StableToolMessageGenerative"}]},"delay":{"allOf":[{"$ref":"StableToolMessageGenerative"}]},"completion":{"allOf":[{"$ref":"StableToolMessageGenerative"}]}}} |
delayMessageID · required | {"nullable":true,"type":"string"} |
failureMessageID · required | {"nullable":true,"type":"string"} |
executionMessageID · required | {"nullable":true,"type":"string"} |
completionMessageID · required | {"nullable":true,"type":"string"} |
delayMessageSeconds · required | {"nullable":true,"type":"number"} |
StableToolMoveRequest
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
type · required | The type of the tool to move. {"type":"string","enum":["api","mcp","function","integration","workflow"],"x-enumNames":["API","MCP","FUNCTION","INTEGRATION","WORKFLOW"]} |
target · required | {"$ref":"StableToolTarget"} |
StableToolMoveResponse
{"type":"object"}
| Property | Definition |
|---|---|
tool · required | {"$ref":"StableToolV2"} |
StableToolReadResponse
{"type":"object"}
| Property | Definition |
|---|---|
tool · required | {"$ref":"StableToolAttachmentV2"} |
StableToolResponse
{"type":"object"}
| Property | Definition |
|---|---|
tool · required | {"$ref":"StableTool"} |
StableToolResponseV2
{"type":"object"}
| Property | Definition |
|---|---|
tool · required | {"$ref":"StableToolAttachmentV2"} |
unresolvedReferences | References this write kept as literal text instead of binding, each with the reason. The write still succeeded. {"type":"array","items":{"$ref":"StableUnresolvedReference"}} |
StableToolTarget
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
global | Target the agent. Cannot be used with playbookID. {"type":"boolean"} |
playbookID | Target a specific playbook. Cannot be used with global. {"type":"string"} |
StableToolUpdateRequest
{"oneOf":[{"type":"object","properties":{"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":"AgentToolCaptureInputVariable"}},"type":{"type":"string","enum":["api"],"description":"Discriminator indicating this tool executes a saved API request.","x-enumNames":["API"]},"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":"Markup"}]},"apiToolInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"type":"object","additionalProperties":{"$ref":"ToolNodeDataAPICaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"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":"AgentToolCaptureInputVariable"}},"type":{"type":"string","enum":["function"],"description":"Discriminator indicating this tool executes a custom function.","x-enumNames":["FUNCTION"]},"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":"Markup"}]},"functionInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"type":"object","additionalProperties":{"$ref":"ToolNodeDataFunctionCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"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":"AgentToolCaptureInputVariable"}},"type":{"type":"string","enum":["mcp"],"description":"Discriminator indicating this tool calls a tool from an MCP server.","x-enumNames":["MCP"]},"inputVariables":{"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]},"mcpIntegrationVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"type":"object","additionalProperties":{"$ref":"ToolNodeDataMcpIntegrationCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"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":"AgentToolCaptureInputVariable"}},"type":{"type":"string","enum":["integration"],"description":"Discriminator indicating this tool calls a connected first-party integration.","x-enumNames":["INTEGRATION"]},"inputVariables":{"type":"object","additionalProperties":{"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"Markup"}]},"integrationToolVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"type":"object","additionalProperties":{"$ref":"ToolNodeDataIntegrationCaptureResponse"},"description":"A map of variable names to the parts of the tool response captured into them."}},"required":["type"],"additionalProperties":false}]}
StableToolUpdateRequestV2
{"oneOf":[{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"messages":{"nullable":true,"allOf":[{"$ref":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs. Replaces the stored one; null removes it; leave it out to keep it.","allOf":[{"$ref":"ToolNodeDataToolSound"}]},"captureInputVariables":{"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed. Null for the whole map removes every entry.","type":"object","additionalProperties":{"nullable":true,"allOf":[{"$ref":"AgentToolCaptureInputVariable"}]}},"type":{"type":"string","enum":["api"],"description":"Discriminator indicating this tool executes a saved API request.","x-enumNames":["API"]},"asyncExecution":{"type":"boolean","description":"When enabled, the tool runs in the background without blocking the conversation."},"inputVariables":{"description":"A map of input names to the values the agent supplies when calling the tool. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.","type":"object","additionalProperties":{"nullable":true,"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"DefaultValueString"}]},"apiToolInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"description":"A map of variable names to the parts of the tool response captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.","type":"object","additionalProperties":{"nullable":true,"allOf":[{"$ref":"ToolNodeDataAPICaptureResponse"}]}}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"messages":{"nullable":true,"allOf":[{"$ref":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs. Replaces the stored one; null removes it; leave it out to keep it.","allOf":[{"$ref":"ToolNodeDataToolSound"}]},"captureInputVariables":{"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed. Null for the whole map removes every entry.","type":"object","additionalProperties":{"nullable":true,"allOf":[{"$ref":"AgentToolCaptureInputVariable"}]}},"type":{"type":"string","enum":["function"],"description":"Discriminator indicating this tool executes a custom function.","x-enumNames":["FUNCTION"]},"asyncExecution":{"type":"boolean","description":"When enabled, the tool runs in the background without blocking the conversation."},"inputVariables":{"description":"A map of input names to the values the agent supplies when calling the tool. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.","type":"object","additionalProperties":{"nullable":true,"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"DefaultValueString"}]},"functionInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"description":"A map of variable names to the parts of the tool response captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.","type":"object","additionalProperties":{"nullable":true,"allOf":[{"$ref":"ToolNodeDataFunctionCaptureResponse"}]}}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"messages":{"nullable":true,"allOf":[{"$ref":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs. Replaces the stored one; null removes it; leave it out to keep it.","allOf":[{"$ref":"ToolNodeDataToolSound"}]},"captureInputVariables":{"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed. Null for the whole map removes every entry.","type":"object","additionalProperties":{"nullable":true,"allOf":[{"$ref":"AgentToolCaptureInputVariable"}]}},"type":{"type":"string","enum":["mcp"],"description":"Discriminator indicating this tool calls a tool from an MCP server.","x-enumNames":["MCP"]},"inputVariables":{"description":"A map of input names to the values the agent supplies when calling the tool. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.","type":"object","additionalProperties":{"nullable":true,"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"DefaultValueString"}]},"mcpIntegrationVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"description":"A map of variable names to the parts of the tool response captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.","type":"object","additionalProperties":{"nullable":true,"allOf":[{"$ref":"ToolNodeDataMcpIntegrationCaptureResponse"}]}}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"description":{"nullable":true,"description":"A description of what the tool does, used by the agent to decide when to call it.","type":"string"},"messages":{"nullable":true,"allOf":[{"$ref":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs. Replaces the stored one; null removes it; leave it out to keep it.","allOf":[{"$ref":"ToolNodeDataToolSound"}]},"captureInputVariables":{"nullable":true,"description":"A map of tool input names to the variables or entities whose values are captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed. Null for the whole map removes every entry.","type":"object","additionalProperties":{"nullable":true,"allOf":[{"$ref":"AgentToolCaptureInputVariable"}]}},"type":{"type":"string","enum":["integration"],"description":"Discriminator indicating this tool calls a connected first-party integration.","x-enumNames":["INTEGRATION"]},"inputVariables":{"description":"A map of input names to the values the agent supplies when calling the tool. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.","type":"object","additionalProperties":{"nullable":true,"type":"object","properties":{"description":{"default":null,"nullable":true,"type":"string"},"defaultValue":{"default":null,"nullable":true,"allOf":[{"$ref":"DefaultValueString"}]},"integrationToolVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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"]}},"captureResponse":{"description":"A map of variable names to the parts of the tool response captured into them. Merged into the stored map by key: an entry you send replaces that entry, an entry you leave out stays, and an entry sent as null is removed.","type":"object","additionalProperties":{"nullable":true,"allOf":[{"$ref":"ToolNodeDataIntegrationCaptureResponse"}]}},"extendedInputVariables":{"description":"Replaces the stored map whole; null removes it; leave it out to keep it.","nullable":true,"type":"object","additionalProperties":{"$ref":"ToolExtendedInputVariable"}}},"required":["type"],"additionalProperties":false}]}
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":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"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":"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":"DefaultValueString"}]},"apiToolInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"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":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"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":"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":"DefaultValueString"}]},"functionInputVariableID":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"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":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"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":"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":"DefaultValueString"}]},"mcpIntegrationVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"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":"StableToolMessages"}]},"toolSound":{"nullable":true,"description":"The sound played while the tool runs, as the editor sets it, or null for none.","allOf":[{"$ref":"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":"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":"DefaultValueString"}]},"integrationToolVariableName":{"type":"string"},"captureType":{"allOf":[{"$ref":"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":"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":"ToolExtendedInputVariable"}}},"required":["id","createdAt","updatedAt","messages","toolSound","description","captureInputVariables","type","integrationToolID","inputVariables","captureResponse","extendedInputVariables"]}]}
StableUnresolvedReference
{"type":"object"}
| Property | Definition |
|---|---|
path · required | Dotted path of the field that carried it, e.g. {"type":"string"} |
token · required | The reference as written, without braces. {"type":"string"} |
reason · required |
{"type":"string","enum":["unknown","secret-not-allowed","path-on-non-variable","resource-id","invalid-name","dangling"],"x-enumNames":["UNKNOWN","SECRET_NOT_ALLOWED","PATH_ON_NON_VARIABLE","RESOURCE_ID","INVALID_NAME","DANGLING"]} |
StableUpdateResponse
{"type":"object"}
| Property | Definition |
|---|---|
message · required | A human-readable message confirming the update. {"type":"string"} |
StableWorkflowTool
{"type":"object"}
| Property | Definition |
|---|---|
id · required | {"type":"string"} |
type · required | Discriminator indicating a workflow the agent can run as a tool. {"type":"string","enum":["workflow"],"x-enumNames":["WORKFLOW"]} |
workflowID · required | The workflow the tool runs. {"type":"string"} |
description · required | When the agent should run the workflow; null uses the workflow's own. {"nullable":true,"type":"string"} |
requiredVariables · required | The variables or entities the model must fill when it calls the tool, in the order they were added, oldest first. The editor lists them newest first. {"type":"array","items":{"$ref":"StableRequiredVariable"}} |
createdAt · required | {"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 · required | {"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))$"} |
ToolExtendedInputVariable
{"type":"object"}
| Property | Definition |
|---|---|
schema | {} |
metadata | {"type":"object","additionalProperties":{}} |
draft | {"allOf":[{"$ref":"ToolExtendedInputVariableSlot"}]} |
ToolExtendedInputVariableSlot
{"type":"object"}
| Property | Definition |
|---|---|
schema | {} |
metadata | {"type":"object","additionalProperties":{}} |
ToolMessageGenerative
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
examples | {"type":"array","items":{"$ref":"Markup"}} |
ToolNodeCaptureType
{"type":"string","enum":["variable","property"],"x-enumNames":["VARIABLE","PROPERTY"]}
ToolNodeDataAPICaptureResponse / ToolNodeDataIntegrationCaptureResponse / ToolNodeDataMcpIntegrationCaptureResponse
{"type":"object"}
| Property | Definition |
|---|---|
path · required | {"type":"string"} |
variableOrEntityID · required | {"nullable":true,"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
ToolNodeDataFunctionCaptureResponse
{"type":"object"}
| Property | Definition |
|---|---|
variableOrEntityID · required | {"nullable":true,"type":"string"} |
functionOutputVariableID · required | {"type":"string"} |
captureType | {"allOf":[{"$ref":"ToolNodeCaptureType"}]} |
ToolNodeDataToolSound
{"type":"object"}
| Property | Definition |
|---|---|
ref · required | {"nullable":true,"type":"string"} |
volume | {"default":0.75,"type":"number","minimum":0,"maximum":1} |
Was this page helpful?
Thanks for your feedback.