Release Notes
Build
Analyze
watsonx Orchestrate Developer Edition
watsonx Orchestrate MCP Server
Legal notices
curl --request POST \
--url https://{api_endpoint}/api/v1/tools/create-from-template \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "<string>",
"description": "<string>",
"category": "<string>",
"spec": {
"description": "<string>",
"permission": "read_only",
"name": "<string>",
"display_name": "<string>",
"input_schema": {
"type": "object",
"properties": {},
"required": []
},
"output_schema": {
"type": "object",
"description": "<string>",
"properties": {},
"items": {
"type": "string",
"title": "<string>",
"description": "<string>",
"properties": {},
"required": [
"<string>"
],
"items": "<unknown>",
"default": "<unknown>",
"enum": [
"<unknown>"
],
"minimum": 123,
"maximum": 123,
"minLength": 123,
"maxLength": 123,
"pattern": "<string>",
"format": "<string>",
"in": "query",
"aliasName": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"required": [],
"format": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"binding": {
"openapi": {
"http_method": "GET",
"http_path": "<string>",
"security": [],
"servers": [],
"connection_id": "<string>",
"callback": {
"callback_url": "<string>",
"method": "GET",
"output_schema": {
"type": "object",
"description": "<string>",
"properties": {},
"items": {
"type": "string",
"title": "<string>",
"description": "<string>",
"properties": {},
"required": [
"<string>"
],
"items": "<unknown>",
"default": "<unknown>",
"enum": [
"<unknown>"
],
"minimum": 123,
"maximum": 123,
"minLength": 123,
"maxLength": 123,
"pattern": "<string>",
"format": "<string>",
"in": "query",
"aliasName": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"required": [],
"format": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"input_schema": {
"type": "object",
"properties": {},
"required": []
}
},
"acknowledgement": {
"output_schema": {
"type": "object",
"description": "<string>",
"properties": {},
"items": {
"type": "string",
"title": "<string>",
"description": "<string>",
"properties": {},
"required": [
"<string>"
],
"items": "<unknown>",
"default": "<unknown>",
"enum": [
"<unknown>"
],
"minimum": 123,
"maximum": 123,
"minLength": 123,
"maxLength": 123,
"pattern": "<string>",
"format": "<string>",
"in": "query",
"aliasName": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"required": [],
"format": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
}
}
},
"python": {
"function": "<string>",
"requirements": [
"<string>"
],
"connections": {}
},
"wxflows": {
"endpoint": "<string>",
"flow_name": "<string>",
"security": []
},
"skill": {
"skillset_id": "<string>",
"skill_id": "<string>",
"skill_operation_path": "<string>",
"http_method": "GET"
},
"client_side": {},
"conversational_search": {
"conversational_search_config": {},
"connections": [
"<unknown>"
],
"version": "0.0.1"
},
"mcp": {
"server_url": "<string>",
"source": "public-registry",
"env": {},
"command": "<string>",
"args": [
"<string>"
],
"transport": "<string>",
"connections": {}
},
"flow": {
"http_method": "GET",
"http_path": "<string>",
"security": [],
"servers": [],
"connection_id": "<string>",
"callback": {
"callback_url": "<string>",
"method": "GET",
"output_schema": {
"type": "object",
"description": "<string>",
"properties": {},
"items": {
"type": "string",
"title": "<string>",
"description": "<string>",
"properties": {},
"required": [
"<string>"
],
"items": "<unknown>",
"default": "<unknown>",
"enum": [
"<unknown>"
],
"minimum": 123,
"maximum": 123,
"minLength": 123,
"maxLength": 123,
"pattern": "<string>",
"format": "<string>",
"in": "query",
"aliasName": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"required": [],
"format": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"input_schema": {
"type": "object",
"properties": {},
"required": []
}
},
"acknowledgement": {
"output_schema": {
"type": "object",
"description": "<string>",
"properties": {},
"items": {
"type": "string",
"title": "<string>",
"description": "<string>",
"properties": {},
"required": [
"<string>"
],
"items": "<unknown>",
"default": "<unknown>",
"enum": [
"<unknown>"
],
"minimum": 123,
"maximum": 123,
"minLength": 123,
"maxLength": 123,
"pattern": "<string>",
"format": "<string>",
"in": "query",
"aliasName": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"required": [],
"format": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
}
},
"flow_id": "",
"version": "TIP",
"dependencies": {
"tools": [],
"agents": []
},
"model": {}
},
"langflow": {
"langflow_id": "<string>",
"project_id": "<string>",
"langflow_version": "<string>",
"connections": {}
}
},
"tags": [
"<unknown>"
],
"is_async": false,
"restrictions": "editable",
"bundled_agent_id": "<string>"
},
"version": "<string>",
"attachments": [
"<unknown>"
]
}
]
'{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Create From Template
curl --request POST \
--url https://{api_endpoint}/api/v1/tools/create-from-template \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "<string>",
"description": "<string>",
"category": "<string>",
"spec": {
"description": "<string>",
"permission": "read_only",
"name": "<string>",
"display_name": "<string>",
"input_schema": {
"type": "object",
"properties": {},
"required": []
},
"output_schema": {
"type": "object",
"description": "<string>",
"properties": {},
"items": {
"type": "string",
"title": "<string>",
"description": "<string>",
"properties": {},
"required": [
"<string>"
],
"items": "<unknown>",
"default": "<unknown>",
"enum": [
"<unknown>"
],
"minimum": 123,
"maximum": 123,
"minLength": 123,
"maxLength": 123,
"pattern": "<string>",
"format": "<string>",
"in": "query",
"aliasName": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"required": [],
"format": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"binding": {
"openapi": {
"http_method": "GET",
"http_path": "<string>",
"security": [],
"servers": [],
"connection_id": "<string>",
"callback": {
"callback_url": "<string>",
"method": "GET",
"output_schema": {
"type": "object",
"description": "<string>",
"properties": {},
"items": {
"type": "string",
"title": "<string>",
"description": "<string>",
"properties": {},
"required": [
"<string>"
],
"items": "<unknown>",
"default": "<unknown>",
"enum": [
"<unknown>"
],
"minimum": 123,
"maximum": 123,
"minLength": 123,
"maxLength": 123,
"pattern": "<string>",
"format": "<string>",
"in": "query",
"aliasName": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"required": [],
"format": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"input_schema": {
"type": "object",
"properties": {},
"required": []
}
},
"acknowledgement": {
"output_schema": {
"type": "object",
"description": "<string>",
"properties": {},
"items": {
"type": "string",
"title": "<string>",
"description": "<string>",
"properties": {},
"required": [
"<string>"
],
"items": "<unknown>",
"default": "<unknown>",
"enum": [
"<unknown>"
],
"minimum": 123,
"maximum": 123,
"minLength": 123,
"maxLength": 123,
"pattern": "<string>",
"format": "<string>",
"in": "query",
"aliasName": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"required": [],
"format": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
}
}
},
"python": {
"function": "<string>",
"requirements": [
"<string>"
],
"connections": {}
},
"wxflows": {
"endpoint": "<string>",
"flow_name": "<string>",
"security": []
},
"skill": {
"skillset_id": "<string>",
"skill_id": "<string>",
"skill_operation_path": "<string>",
"http_method": "GET"
},
"client_side": {},
"conversational_search": {
"conversational_search_config": {},
"connections": [
"<unknown>"
],
"version": "0.0.1"
},
"mcp": {
"server_url": "<string>",
"source": "public-registry",
"env": {},
"command": "<string>",
"args": [
"<string>"
],
"transport": "<string>",
"connections": {}
},
"flow": {
"http_method": "GET",
"http_path": "<string>",
"security": [],
"servers": [],
"connection_id": "<string>",
"callback": {
"callback_url": "<string>",
"method": "GET",
"output_schema": {
"type": "object",
"description": "<string>",
"properties": {},
"items": {
"type": "string",
"title": "<string>",
"description": "<string>",
"properties": {},
"required": [
"<string>"
],
"items": "<unknown>",
"default": "<unknown>",
"enum": [
"<unknown>"
],
"minimum": 123,
"maximum": 123,
"minLength": 123,
"maxLength": 123,
"pattern": "<string>",
"format": "<string>",
"in": "query",
"aliasName": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"required": [],
"format": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"input_schema": {
"type": "object",
"properties": {},
"required": []
}
},
"acknowledgement": {
"output_schema": {
"type": "object",
"description": "<string>",
"properties": {},
"items": {
"type": "string",
"title": "<string>",
"description": "<string>",
"properties": {},
"required": [
"<string>"
],
"items": "<unknown>",
"default": "<unknown>",
"enum": [
"<unknown>"
],
"minimum": 123,
"maximum": 123,
"minLength": 123,
"maxLength": 123,
"pattern": "<string>",
"format": "<string>",
"in": "query",
"aliasName": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
},
"required": [],
"format": "<string>",
"anyOf": [
"<unknown>"
],
"oneOf": [
"<unknown>"
],
"allOf": [
"<unknown>"
]
}
},
"flow_id": "",
"version": "TIP",
"dependencies": {
"tools": [],
"agents": []
},
"model": {}
},
"langflow": {
"langflow_id": "<string>",
"project_id": "<string>",
"langflow_version": "<string>",
"connections": {}
}
},
"tags": [
"<unknown>"
],
"is_async": false,
"restrictions": "editable",
"bundled_agent_id": "<string>"
},
"version": "<string>",
"attachments": [
"<unknown>"
]
}
]
'{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Body
A specification for a tool that can be used in an agent.
Show child attributes
Show child attributes
The permission level required to use this tool.
read_only, write_only, read_write, admin Name of the tool
Display name of the tool
A request body for a tool.
Show child attributes
Show child attributes
object, string Show child attributes
Show child attributes
A JSON Schema object that defines the structure and validation rules for JSON data.
- JsonSchemaObject
- FlexibleProperty
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null query, header, path, body A response body for a tool.
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null Show child attributes
Show child attributes
A JSON Schema object that defines the structure and validation rules for JSON data.
- JsonSchemaObject
- FlexibleProperty
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null query, header, path, body A JSON Schema object that defines the structure and validation rules for JSON data.
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null query, header, path, body A binding of the tool to a specific runtime environment such as an OpenAPI endpoint or local Python function.
Show child attributes
Show child attributes
A binding for a tool that uses an OpenAPI endpoint.
Show child attributes
Show child attributes
GET, POST, PUT, PATCH, DELETE Show child attributes
Show child attributes
apiKey, http, oauth2, openIdConnect basic, bearer, oauth query, header, cookie A binding for a tool that uses a callback URL.
Show child attributes
Show child attributes
The URL to send the callback to
The HTTP method to use for the callback
GET, POST, PUT, PATCH, DELETE The schema for the callback response body
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null Show child attributes
Show child attributes
A JSON Schema object that defines the structure and validation rules for JSON data.
- JsonSchemaObject
- FlexibleProperty
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null query, header, path, body A JSON Schema object that defines the structure and validation rules for JSON data.
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null query, header, path, body The schema for the callback request body
Show child attributes
Show child attributes
object, string Show child attributes
Show child attributes
A JSON Schema object that defines the structure and validation rules for JSON data.
- JsonSchemaObject
- FlexibleProperty
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null query, header, path, body A acknowledgment for the tools that are async
Show child attributes
Show child attributes
The schema of the original response from the callback.
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null Show child attributes
Show child attributes
A JSON Schema object that defines the structure and validation rules for JSON data.
- JsonSchemaObject
- FlexibleProperty
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null query, header, path, body A JSON Schema object that defines the structure and validation rules for JSON data.
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null query, header, path, body A binding for a tool that uses a Python function.
Show child attributes
Show child attributes
The fully qualified name of the Python function to call.
details of any requirements that are to be installed along with tool
details of the credential connections of the Python tool
A binding for a tool that uses a watsonx.ai Flows agent.
Show child attributes
Show child attributes
The wxflows endpoint.
The name of the flow to call.
A security scheme for an OpenAPI endpoint.
Show child attributes
Show child attributes
apiKey, http, oauth2, openIdConnect basic, bearer, oauth query, header, cookie A binding for a tool that uses a watsonx Orchestrate Skill.
Show child attributes
Show child attributes
The ID of the skillset containing the skill to call.
The ID of the skill to call.
The path to the skill operation to call.
GET, POST, PUT, PATCH, DELETE A binding for a tool that is executed on the client side.
A binding for a tool that from MCP server.
Show child attributes
Show child attributes
mcp server url to connect to
public-registry, files details of the envs to be set
command to start the mcp server
arguments to start the mcp server
transport protocol of remote mcp
details of the credential connections of the Python tool
A binding for a tool that uses a flow. A flow tool is called as an OpenAPI tool.
Show child attributes
Show child attributes
GET, POST, PUT, PATCH, DELETE Show child attributes
Show child attributes
apiKey, http, oauth2, openIdConnect basic, bearer, oauth query, header, cookie A binding for a tool that uses a callback URL.
Show child attributes
Show child attributes
The URL to send the callback to
The HTTP method to use for the callback
GET, POST, PUT, PATCH, DELETE The schema for the callback response body
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null Show child attributes
Show child attributes
A JSON Schema object that defines the structure and validation rules for JSON data.
- JsonSchemaObject
- FlexibleProperty
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null query, header, path, body A JSON Schema object that defines the structure and validation rules for JSON data.
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null query, header, path, body The schema for the callback request body
Show child attributes
Show child attributes
object, string Show child attributes
Show child attributes
A JSON Schema object that defines the structure and validation rules for JSON data.
- JsonSchemaObject
- FlexibleProperty
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null query, header, path, body A acknowledgment for the tools that are async
Show child attributes
Show child attributes
The schema of the original response from the callback.
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null Show child attributes
Show child attributes
A JSON Schema object that defines the structure and validation rules for JSON data.
- JsonSchemaObject
- FlexibleProperty
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null query, header, path, body A JSON Schema object that defines the structure and validation rules for JSON data.
Show child attributes
Show child attributes
object, string, number, integer, boolean, array, null query, header, path, body The ID of the flow to call.
The version of the flow to call.
The flow model to be used to generate an OpenAPI spec. This won't be stored.
A binding for a tool that uses Langflow.
Show child attributes
Show child attributes
The ID of langflow that is binded
The ID of project in which Langflow is created
The version of the Langflow tool binded
details of the credential connections of the Langflow tool
Whether the tool execution is asynchronous
Whether the tool can be edited
Base agent id
Response
Successful Response