Create A Tool

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A specification for a tool that can be used in an agent.

description

string

required

permission

enum<string>

required

The permission level required to use this tool.

Available options:

read_only,

write_only,

read_write,

admin

name

string | null

Name of the tool

display_name

string | null

Display name of the tool

input_schema

ToolRequestBody · object

A request body for a tool.

Show child attributes

input_schema.type

enum<string>

default:object

Available options:

object,

string

input_schema.properties

Properties · object

Show child attributes

input_schema.properties.{key}

JsonSchemaObject · object

A JSON Schema object that defines the structure and validation rules for JSON data.

JsonSchemaObject
FlexibleProperty

Show child attributes

input_schema.properties.{key}.type

enum<string>

default:string

Available options:

object,

string,

number,

integer,

boolean,

array,

null

input_schema.properties.{key}.title

string | null

input_schema.properties.{key}.description

string | null

input_schema.properties.{key}.properties

Properties · object

input_schema.properties.{key}.required

string[] | null

input_schema.properties.{key}.items

unknown

input_schema.properties.{key}.default

unknown

input_schema.properties.{key}.enum

any[] | null

input_schema.properties.{key}.minimum

number | null

input_schema.properties.{key}.maximum

number | null

input_schema.properties.{key}.minLength

integer | null

input_schema.properties.{key}.maxLength

integer | null

input_schema.properties.{key}.pattern

string | null

input_schema.properties.{key}.format

string | null

input_schema.properties.{key}.in

enum<string> | null

Available options:

query,

header,

path,

body

input_schema.properties.{key}.aliasName

string | null

input_schema.properties.{key}.anyOf

any[] | null

input_schema.properties.{key}.oneOf

any[] | null

input_schema.properties.{key}.allOf

any[] | null

input_schema.required

string[] | null

output_schema

ToolResponseBody · object

A response body for a tool.

Show child attributes

output_schema.type

enum<string>

default:object

Available options:

object,

string,

number,

integer,

boolean,

array,

null

output_schema.description

string | null

output_schema.properties

Properties · object

Show child attributes

output_schema.properties.{key}

JsonSchemaObject · object

A JSON Schema object that defines the structure and validation rules for JSON data.

JsonSchemaObject
FlexibleProperty

Show child attributes

output_schema.properties.{key}.type

enum<string>

default:string

Available options:

object,

string,

number,

integer,

boolean,

array,

null

output_schema.properties.{key}.title

string | null

output_schema.properties.{key}.description

string | null

output_schema.properties.{key}.properties

Properties · object

output_schema.properties.{key}.required

string[] | null

output_schema.properties.{key}.items

unknown

output_schema.properties.{key}.default

unknown

output_schema.properties.{key}.enum

any[] | null

output_schema.properties.{key}.minimum

number | null

output_schema.properties.{key}.maximum

number | null

output_schema.properties.{key}.minLength

integer | null

output_schema.properties.{key}.maxLength

integer | null

output_schema.properties.{key}.pattern

string | null

output_schema.properties.{key}.format

string | null

output_schema.properties.{key}.in

enum<string> | null

Available options:

query,

header,

path,

body

output_schema.properties.{key}.aliasName

string | null

output_schema.properties.{key}.anyOf

any[] | null

output_schema.properties.{key}.oneOf

any[] | null

output_schema.properties.{key}.allOf

any[] | null

output_schema.items

JsonSchemaObject · object

A JSON Schema object that defines the structure and validation rules for JSON data.

Show child attributes

output_schema.items.type

enum<string>

default:string

Available options:

object,

string,

number,

integer,

boolean,

array,

null

output_schema.items.title

string | null

output_schema.items.description

string | null

output_schema.items.properties

Properties · object

output_schema.items.required

string[] | null

output_schema.items.items

unknown

output_schema.items.default

unknown

output_schema.items.enum

any[] | null

output_schema.items.minimum

number | null

output_schema.items.maximum

number | null

output_schema.items.minLength

integer | null

output_schema.items.maxLength

integer | null

output_schema.items.pattern

string | null

output_schema.items.format

string | null

output_schema.items.in

enum<string> | null

Available options:

query,

header,

path,

body

output_schema.items.aliasName

string | null

output_schema.items.anyOf

any[] | null

output_schema.items.oneOf

any[] | null

output_schema.items.allOf

any[] | null

output_schema.required

string[] | null

output_schema.format

string | null

output_schema.anyOf

any[] | null

output_schema.oneOf

any[] | null

output_schema.allOf

any[] | null

binding

ToolBinding · object

A binding of the tool to a specific runtime environment such as an OpenAPI endpoint or local Python function.

Show child attributes

binding.openapi

OpenApiToolBinding · object

A binding for a tool that uses an OpenAPI endpoint.

Show child attributes

binding.openapi.http_method

enum<string>

required

Available options:

GET,

POST,

PUT,

PATCH,

DELETE

binding.openapi.http_path

string

required

binding.openapi.security

OpenApiSecurityScheme · object[]

Show child attributes

binding.openapi.security.type

enum<string> | null

Available options:

apiKey,

http,

oauth2,

openIdConnect

binding.openapi.security.scheme

enum<string> | null

Available options:

basic,

bearer,

oauth

binding.openapi.security.in

enum<string> | null

Available options:

query,

header,

cookie

binding.openapi.security.name

string | null

binding.openapi.security.description

string | null

binding.openapi.security.open_id_connect_url

string | null

default:openIdConnectUrl

binding.openapi.security.flows

Flows · object

binding.openapi.servers

string[]

binding.openapi.connection_id

string | null

binding.openapi.callback

CallbackBinding · object

A binding for a tool that uses a callback URL.

Show child attributes

binding.openapi.callback.callback_url

string

required

The URL to send the callback to

binding.openapi.callback.method

enum<string>

required

The HTTP method to use for the callback

Available options:

GET,

POST,

PUT,

PATCH,

DELETE

binding.openapi.callback.output_schema

ToolResponseBody · object

required

The schema for the callback response body

Show child attributes

binding.openapi.callback.output_schema.type

enum<string>

default:object

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.openapi.callback.output_schema.description

string | null

binding.openapi.callback.output_schema.properties

Properties · object

Show child attributes

binding.openapi.callback.output_schema.properties.{key}

JsonSchemaObject · object

A JSON Schema object that defines the structure and validation rules for JSON data.

JsonSchemaObject
FlexibleProperty

Show child attributes

binding.openapi.callback.output_schema.properties.{key}.type

enum<string>

default:string

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.openapi.callback.output_schema.properties.{key}.title

string | null

binding.openapi.callback.output_schema.properties.{key}.description

string | null

binding.openapi.callback.output_schema.properties.{key}.properties

Properties · object

binding.openapi.callback.output_schema.properties.{key}.required

string[] | null

binding.openapi.callback.output_schema.properties.{key}.items

unknown

binding.openapi.callback.output_schema.properties.{key}.default

unknown

binding.openapi.callback.output_schema.properties.{key}.enum

any[] | null

binding.openapi.callback.output_schema.properties.{key}.minimum

number | null

binding.openapi.callback.output_schema.properties.{key}.maximum

number | null

binding.openapi.callback.output_schema.properties.{key}.minLength

integer | null

binding.openapi.callback.output_schema.properties.{key}.maxLength

integer | null

binding.openapi.callback.output_schema.properties.{key}.pattern

string | null

binding.openapi.callback.output_schema.properties.{key}.format

string | null

binding.openapi.callback.output_schema.properties.{key}.in

enum<string> | null

Available options:

query,

header,

path,

body

binding.openapi.callback.output_schema.properties.{key}.aliasName

string | null

binding.openapi.callback.output_schema.properties.{key}.anyOf

any[] | null

binding.openapi.callback.output_schema.properties.{key}.oneOf

any[] | null

binding.openapi.callback.output_schema.properties.{key}.allOf

any[] | null

binding.openapi.callback.output_schema.items

JsonSchemaObject · object

A JSON Schema object that defines the structure and validation rules for JSON data.

Show child attributes

binding.openapi.callback.output_schema.items.type

enum<string>

default:string

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.openapi.callback.output_schema.items.title

string | null

binding.openapi.callback.output_schema.items.description

string | null

binding.openapi.callback.output_schema.items.properties

Properties · object

binding.openapi.callback.output_schema.items.required

string[] | null

binding.openapi.callback.output_schema.items.items

unknown

binding.openapi.callback.output_schema.items.default

unknown

binding.openapi.callback.output_schema.items.enum

any[] | null

binding.openapi.callback.output_schema.items.minimum

number | null

binding.openapi.callback.output_schema.items.maximum

number | null

binding.openapi.callback.output_schema.items.minLength

integer | null

binding.openapi.callback.output_schema.items.maxLength

integer | null

binding.openapi.callback.output_schema.items.pattern

string | null

binding.openapi.callback.output_schema.items.format

string | null

binding.openapi.callback.output_schema.items.in

enum<string> | null

Available options:

query,

header,

path,

body

binding.openapi.callback.output_schema.items.aliasName

string | null

binding.openapi.callback.output_schema.items.anyOf

any[] | null

binding.openapi.callback.output_schema.items.oneOf

any[] | null

binding.openapi.callback.output_schema.items.allOf

any[] | null

binding.openapi.callback.output_schema.required

string[] | null

binding.openapi.callback.output_schema.format

string | null

binding.openapi.callback.output_schema.anyOf

any[] | null

binding.openapi.callback.output_schema.oneOf

any[] | null

binding.openapi.callback.output_schema.allOf

any[] | null

binding.openapi.callback.input_schema

ToolRequestBody · object

The schema for the callback request body

Show child attributes

binding.openapi.callback.input_schema.type

enum<string>

default:object

Available options:

object,

string

binding.openapi.callback.input_schema.properties

Properties · object

Show child attributes

binding.openapi.callback.input_schema.properties.{key}

JsonSchemaObject · object

A JSON Schema object that defines the structure and validation rules for JSON data.

JsonSchemaObject
FlexibleProperty

Show child attributes

binding.openapi.callback.input_schema.properties.{key}.type

enum<string>

default:string

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.openapi.callback.input_schema.properties.{key}.title

string | null

binding.openapi.callback.input_schema.properties.{key}.description

string | null

binding.openapi.callback.input_schema.properties.{key}.properties

Properties · object

binding.openapi.callback.input_schema.properties.{key}.required

string[] | null

binding.openapi.callback.input_schema.properties.{key}.items

unknown

binding.openapi.callback.input_schema.properties.{key}.default

unknown

binding.openapi.callback.input_schema.properties.{key}.enum

any[] | null

binding.openapi.callback.input_schema.properties.{key}.minimum

number | null

binding.openapi.callback.input_schema.properties.{key}.maximum

number | null

binding.openapi.callback.input_schema.properties.{key}.minLength

integer | null

binding.openapi.callback.input_schema.properties.{key}.maxLength

integer | null

binding.openapi.callback.input_schema.properties.{key}.pattern

string | null

binding.openapi.callback.input_schema.properties.{key}.format

string | null

binding.openapi.callback.input_schema.properties.{key}.in

enum<string> | null

Available options:

query,

header,

path,

body

binding.openapi.callback.input_schema.properties.{key}.aliasName

string | null

binding.openapi.callback.input_schema.properties.{key}.anyOf

any[] | null

binding.openapi.callback.input_schema.properties.{key}.oneOf

any[] | null

binding.openapi.callback.input_schema.properties.{key}.allOf

any[] | null

binding.openapi.callback.input_schema.required

string[] | null

binding.openapi.acknowledgement

AcknowledgementResponseBody · object

A acknowledgment for the tools that are async

Show child attributes

binding.openapi.acknowledgement.output_schema

ToolResponseBody · object

required

The schema of the original response from the callback.

Show child attributes

binding.openapi.acknowledgement.output_schema.type

enum<string>

default:object

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.openapi.acknowledgement.output_schema.description

string | null

binding.openapi.acknowledgement.output_schema.properties

Properties · object

Show child attributes

binding.openapi.acknowledgement.output_schema.properties.{key}

JsonSchemaObject · object

A JSON Schema object that defines the structure and validation rules for JSON data.

JsonSchemaObject
FlexibleProperty

Show child attributes

binding.openapi.acknowledgement.output_schema.properties.{key}.type

enum<string>

default:string

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.openapi.acknowledgement.output_schema.properties.{key}.title

string | null

binding.openapi.acknowledgement.output_schema.properties.{key}.description

string | null

binding.openapi.acknowledgement.output_schema.properties.{key}.properties

Properties · object

binding.openapi.acknowledgement.output_schema.properties.{key}.required

string[] | null

binding.openapi.acknowledgement.output_schema.properties.{key}.items

unknown

binding.openapi.acknowledgement.output_schema.properties.{key}.default

unknown

binding.openapi.acknowledgement.output_schema.properties.{key}.enum

any[] | null

binding.openapi.acknowledgement.output_schema.properties.{key}.minimum

number | null

binding.openapi.acknowledgement.output_schema.properties.{key}.maximum

number | null

binding.openapi.acknowledgement.output_schema.properties.{key}.minLength

integer | null

binding.openapi.acknowledgement.output_schema.properties.{key}.maxLength

integer | null

binding.openapi.acknowledgement.output_schema.properties.{key}.pattern

string | null

binding.openapi.acknowledgement.output_schema.properties.{key}.format

string | null

binding.openapi.acknowledgement.output_schema.properties.{key}.in

enum<string> | null

Available options:

query,

header,

path,

body

binding.openapi.acknowledgement.output_schema.properties.{key}.aliasName

string | null

binding.openapi.acknowledgement.output_schema.properties.{key}.anyOf

any[] | null

binding.openapi.acknowledgement.output_schema.properties.{key}.oneOf

any[] | null

binding.openapi.acknowledgement.output_schema.properties.{key}.allOf

any[] | null

binding.openapi.acknowledgement.output_schema.items

JsonSchemaObject · object

A JSON Schema object that defines the structure and validation rules for JSON data.

Show child attributes

binding.openapi.acknowledgement.output_schema.items.type

enum<string>

default:string

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.openapi.acknowledgement.output_schema.items.title

string | null

binding.openapi.acknowledgement.output_schema.items.description

string | null

binding.openapi.acknowledgement.output_schema.items.properties

Properties · object

binding.openapi.acknowledgement.output_schema.items.required

string[] | null

binding.openapi.acknowledgement.output_schema.items.items

unknown

binding.openapi.acknowledgement.output_schema.items.default

unknown

binding.openapi.acknowledgement.output_schema.items.enum

any[] | null

binding.openapi.acknowledgement.output_schema.items.minimum

number | null

binding.openapi.acknowledgement.output_schema.items.maximum

number | null

binding.openapi.acknowledgement.output_schema.items.minLength

integer | null

binding.openapi.acknowledgement.output_schema.items.maxLength

integer | null

binding.openapi.acknowledgement.output_schema.items.pattern

string | null

binding.openapi.acknowledgement.output_schema.items.format

string | null

binding.openapi.acknowledgement.output_schema.items.in

enum<string> | null

Available options:

query,

header,

path,

body

binding.openapi.acknowledgement.output_schema.items.aliasName

string | null

binding.openapi.acknowledgement.output_schema.items.anyOf

any[] | null

binding.openapi.acknowledgement.output_schema.items.oneOf

any[] | null

binding.openapi.acknowledgement.output_schema.items.allOf

any[] | null

binding.openapi.acknowledgement.output_schema.required

string[] | null

binding.openapi.acknowledgement.output_schema.format

string | null

binding.openapi.acknowledgement.output_schema.anyOf

any[] | null

binding.openapi.acknowledgement.output_schema.oneOf

any[] | null

binding.openapi.acknowledgement.output_schema.allOf

any[] | null

binding.python

PythonToolBinding · object

A binding for a tool that uses a Python function.

Show child attributes

binding.python.function

string

required

The fully qualified name of the Python function to call.

binding.python.requirements

string[]

details of any requirements that are to be installed along with tool

binding.python.connections

Connections · object

details of the credential connections of the Python tool

binding.wxflows

WxFlowsToolBinding · object

A binding for a tool that uses a watsonx.ai Flows agent.

Show child attributes

binding.wxflows.endpoint

string

required

The wxflows endpoint.

binding.wxflows.flow_name

string

required

The name of the flow to call.

binding.wxflows.security

OpenApiSecurityScheme · object

A security scheme for an OpenAPI endpoint.

Show child attributes

binding.wxflows.security.type

enum<string> | null

Available options:

apiKey,

http,

oauth2,

openIdConnect

binding.wxflows.security.scheme

enum<string> | null

Available options:

basic,

bearer,

oauth

binding.wxflows.security.in

enum<string> | null

Available options:

query,

header,

cookie

binding.wxflows.security.name

string | null

binding.wxflows.security.description

string | null

binding.wxflows.security.open_id_connect_url

string | null

default:openIdConnectUrl

binding.wxflows.security.flows

Flows · object

binding.skill

SkillToolBinding · object

A binding for a tool that uses a watsonx Orchestrate Skill.

Show child attributes

binding.skill.skillset_id

string

required

The ID of the skillset containing the skill to call.

binding.skill.skill_id

string

required

The ID of the skill to call.

binding.skill.skill_operation_path

string

required

The path to the skill operation to call.

binding.skill.http_method

enum<string>

required

Available options:

GET,

POST,

PUT,

PATCH,

DELETE

binding.client_side

ClientSideToolBinding · object

A binding for a tool that is executed on the client side.

binding.conversational_search

ConversationalSearchToolBinding · object

Show child attributes

binding.conversational_search.conversational_search_config

Conversational Search Config · object

binding.conversational_search.connections

any[]

binding.conversational_search.version

string

default:0.0.1

binding.mcp

MCPToolBinding · object

A binding for a tool that from MCP server.

Show child attributes

binding.mcp.server_url

string | null

mcp server url to connect to

binding.mcp.source

enum<string> | null

Available options:

public-registry,

files

binding.mcp.env

Env · object

details of the envs to be set

binding.mcp.command

string | null

command to start the mcp server

binding.mcp.args

string[]

arguments to start the mcp server

binding.mcp.transport

string | null

transport protocol of remote mcp

binding.mcp.connections

Connections · object

details of the credential connections of the Python tool

binding.flow

FlowToolBinding · object

A binding for a tool that uses a flow. A flow tool is called as an OpenAPI tool.

Show child attributes

binding.flow.http_method

enum<string> | null

Available options:

GET,

POST,

PUT,

PATCH,

DELETE

binding.flow.http_path

string | null

binding.flow.security

OpenApiSecurityScheme · object[]

Show child attributes

binding.flow.security.type

enum<string> | null

Available options:

apiKey,

http,

oauth2,

openIdConnect

binding.flow.security.scheme

enum<string> | null

Available options:

basic,

bearer,

oauth

binding.flow.security.in

enum<string> | null

Available options:

query,

header,

cookie

binding.flow.security.name

string | null

binding.flow.security.description

string | null

binding.flow.security.open_id_connect_url

string | null

default:openIdConnectUrl

binding.flow.security.flows

Flows · object

binding.flow.servers

string[]

binding.flow.connection_id

string | null

binding.flow.callback

CallbackBinding · object

A binding for a tool that uses a callback URL.

Show child attributes

binding.flow.callback.callback_url

string

required

The URL to send the callback to

binding.flow.callback.method

enum<string>

required

The HTTP method to use for the callback

Available options:

GET,

POST,

PUT,

PATCH,

DELETE

binding.flow.callback.output_schema

ToolResponseBody · object

required

The schema for the callback response body

Show child attributes

binding.flow.callback.output_schema.type

enum<string>

default:object

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.flow.callback.output_schema.description

string | null

binding.flow.callback.output_schema.properties

Properties · object

Show child attributes

binding.flow.callback.output_schema.properties.{key}

JsonSchemaObject · object

A JSON Schema object that defines the structure and validation rules for JSON data.

JsonSchemaObject
FlexibleProperty

Show child attributes

binding.flow.callback.output_schema.properties.{key}.type

enum<string>

default:string

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.flow.callback.output_schema.properties.{key}.title

string | null

binding.flow.callback.output_schema.properties.{key}.description

string | null

binding.flow.callback.output_schema.properties.{key}.properties

Properties · object

binding.flow.callback.output_schema.properties.{key}.required

string[] | null

binding.flow.callback.output_schema.properties.{key}.items

unknown

binding.flow.callback.output_schema.properties.{key}.default

unknown

binding.flow.callback.output_schema.properties.{key}.enum

any[] | null

binding.flow.callback.output_schema.properties.{key}.minimum

number | null

binding.flow.callback.output_schema.properties.{key}.maximum

number | null

binding.flow.callback.output_schema.properties.{key}.minLength

integer | null

binding.flow.callback.output_schema.properties.{key}.maxLength

integer | null

binding.flow.callback.output_schema.properties.{key}.pattern

string | null

binding.flow.callback.output_schema.properties.{key}.format

string | null

binding.flow.callback.output_schema.properties.{key}.in

enum<string> | null

Available options:

query,

header,

path,

body

binding.flow.callback.output_schema.properties.{key}.aliasName

string | null

binding.flow.callback.output_schema.properties.{key}.anyOf

any[] | null

binding.flow.callback.output_schema.properties.{key}.oneOf

any[] | null

binding.flow.callback.output_schema.properties.{key}.allOf

any[] | null

binding.flow.callback.output_schema.items

JsonSchemaObject · object

A JSON Schema object that defines the structure and validation rules for JSON data.

Show child attributes

binding.flow.callback.output_schema.items.type

enum<string>

default:string

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.flow.callback.output_schema.items.title

string | null

binding.flow.callback.output_schema.items.description

string | null

binding.flow.callback.output_schema.items.properties

Properties · object

binding.flow.callback.output_schema.items.required

string[] | null

binding.flow.callback.output_schema.items.items

unknown

binding.flow.callback.output_schema.items.default

unknown

binding.flow.callback.output_schema.items.enum

any[] | null

binding.flow.callback.output_schema.items.minimum

number | null

binding.flow.callback.output_schema.items.maximum

number | null

binding.flow.callback.output_schema.items.minLength

integer | null

binding.flow.callback.output_schema.items.maxLength

integer | null

binding.flow.callback.output_schema.items.pattern

string | null

binding.flow.callback.output_schema.items.format

string | null

binding.flow.callback.output_schema.items.in

enum<string> | null

Available options:

query,

header,

path,

body

binding.flow.callback.output_schema.items.aliasName

string | null

binding.flow.callback.output_schema.items.anyOf

any[] | null

binding.flow.callback.output_schema.items.oneOf

any[] | null

binding.flow.callback.output_schema.items.allOf

any[] | null

binding.flow.callback.output_schema.required

string[] | null

binding.flow.callback.output_schema.format

string | null

binding.flow.callback.output_schema.anyOf

any[] | null

binding.flow.callback.output_schema.oneOf

any[] | null

binding.flow.callback.output_schema.allOf

any[] | null

binding.flow.callback.input_schema

ToolRequestBody · object

The schema for the callback request body

Show child attributes

binding.flow.callback.input_schema.type

enum<string>

default:object

Available options:

object,

string

binding.flow.callback.input_schema.properties

Properties · object

Show child attributes

binding.flow.callback.input_schema.properties.{key}

JsonSchemaObject · object

A JSON Schema object that defines the structure and validation rules for JSON data.

JsonSchemaObject
FlexibleProperty

Show child attributes

binding.flow.callback.input_schema.properties.{key}.type

enum<string>

default:string

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.flow.callback.input_schema.properties.{key}.title

string | null

binding.flow.callback.input_schema.properties.{key}.description

string | null

binding.flow.callback.input_schema.properties.{key}.properties

Properties · object

binding.flow.callback.input_schema.properties.{key}.required

string[] | null

binding.flow.callback.input_schema.properties.{key}.items

unknown

binding.flow.callback.input_schema.properties.{key}.default

unknown

binding.flow.callback.input_schema.properties.{key}.enum

any[] | null

binding.flow.callback.input_schema.properties.{key}.minimum

number | null

binding.flow.callback.input_schema.properties.{key}.maximum

number | null

binding.flow.callback.input_schema.properties.{key}.minLength

integer | null

binding.flow.callback.input_schema.properties.{key}.maxLength

integer | null

binding.flow.callback.input_schema.properties.{key}.pattern

string | null

binding.flow.callback.input_schema.properties.{key}.format

string | null

binding.flow.callback.input_schema.properties.{key}.in

enum<string> | null

Available options:

query,

header,

path,

body

binding.flow.callback.input_schema.properties.{key}.aliasName

string | null

binding.flow.callback.input_schema.properties.{key}.anyOf

any[] | null

binding.flow.callback.input_schema.properties.{key}.oneOf

any[] | null

binding.flow.callback.input_schema.properties.{key}.allOf

any[] | null

binding.flow.callback.input_schema.required

string[] | null

binding.flow.acknowledgement

AcknowledgementResponseBody · object

A acknowledgment for the tools that are async

Show child attributes

binding.flow.acknowledgement.output_schema

ToolResponseBody · object

required

The schema of the original response from the callback.

Show child attributes

binding.flow.acknowledgement.output_schema.type

enum<string>

default:object

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.flow.acknowledgement.output_schema.description

string | null

binding.flow.acknowledgement.output_schema.properties

Properties · object

Show child attributes

binding.flow.acknowledgement.output_schema.properties.{key}

JsonSchemaObject · object

A JSON Schema object that defines the structure and validation rules for JSON data.

JsonSchemaObject
FlexibleProperty

Show child attributes

binding.flow.acknowledgement.output_schema.properties.{key}.type

enum<string>

default:string

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.flow.acknowledgement.output_schema.properties.{key}.title

string | null

binding.flow.acknowledgement.output_schema.properties.{key}.description

string | null

binding.flow.acknowledgement.output_schema.properties.{key}.properties

Properties · object

binding.flow.acknowledgement.output_schema.properties.{key}.required

string[] | null

binding.flow.acknowledgement.output_schema.properties.{key}.items

unknown

binding.flow.acknowledgement.output_schema.properties.{key}.default

unknown

binding.flow.acknowledgement.output_schema.properties.{key}.enum

any[] | null

binding.flow.acknowledgement.output_schema.properties.{key}.minimum

number | null

binding.flow.acknowledgement.output_schema.properties.{key}.maximum

number | null

binding.flow.acknowledgement.output_schema.properties.{key}.minLength

integer | null

binding.flow.acknowledgement.output_schema.properties.{key}.maxLength

integer | null

binding.flow.acknowledgement.output_schema.properties.{key}.pattern

string | null

binding.flow.acknowledgement.output_schema.properties.{key}.format

string | null

binding.flow.acknowledgement.output_schema.properties.{key}.in

enum<string> | null

Available options:

query,

header,

path,

body

binding.flow.acknowledgement.output_schema.properties.{key}.aliasName

string | null

binding.flow.acknowledgement.output_schema.properties.{key}.anyOf

any[] | null

binding.flow.acknowledgement.output_schema.properties.{key}.oneOf

any[] | null

binding.flow.acknowledgement.output_schema.properties.{key}.allOf

any[] | null

binding.flow.acknowledgement.output_schema.items

JsonSchemaObject · object

A JSON Schema object that defines the structure and validation rules for JSON data.

Show child attributes

binding.flow.acknowledgement.output_schema.items.type

enum<string>

default:string

Available options:

object,

string,

number,

integer,

boolean,

array,

null

binding.flow.acknowledgement.output_schema.items.title

string | null

binding.flow.acknowledgement.output_schema.items.description

string | null

binding.flow.acknowledgement.output_schema.items.properties

Properties · object

binding.flow.acknowledgement.output_schema.items.required

string[] | null

binding.flow.acknowledgement.output_schema.items.items

unknown

binding.flow.acknowledgement.output_schema.items.default

unknown

binding.flow.acknowledgement.output_schema.items.enum

any[] | null

binding.flow.acknowledgement.output_schema.items.minimum

number | null

binding.flow.acknowledgement.output_schema.items.maximum

number | null

binding.flow.acknowledgement.output_schema.items.minLength

integer | null

binding.flow.acknowledgement.output_schema.items.maxLength

integer | null

binding.flow.acknowledgement.output_schema.items.pattern

string | null

binding.flow.acknowledgement.output_schema.items.format

string | null

binding.flow.acknowledgement.output_schema.items.in

enum<string> | null

Available options:

query,

header,

path,

body

binding.flow.acknowledgement.output_schema.items.aliasName

string | null

binding.flow.acknowledgement.output_schema.items.anyOf

any[] | null

binding.flow.acknowledgement.output_schema.items.oneOf

any[] | null

binding.flow.acknowledgement.output_schema.items.allOf

any[] | null

binding.flow.acknowledgement.output_schema.required

string[] | null

binding.flow.acknowledgement.output_schema.format

string | null

binding.flow.acknowledgement.output_schema.anyOf

any[] | null

binding.flow.acknowledgement.output_schema.oneOf

any[] | null

binding.flow.acknowledgement.output_schema.allOf

any[] | null

binding.flow.flow_id

string

default:""

The ID of the flow to call.

binding.flow.version

string

default:TIP

The version of the flow to call.

binding.flow.dependencies

FlowDependencies · object

The dependencies of the flow.

Show child attributes

binding.flow.dependencies.tools

string[]

binding.flow.dependencies.agents

string[]

binding.flow.model

Model · object

The flow model to be used to generate an OpenAPI spec. This won't be stored.

binding.langflow

LangflowToolBinding · object

A binding for a tool that uses Langflow.

Show child attributes

binding.langflow.langflow_id

string | null

The ID of langflow that is binded

binding.langflow.project_id

string | null

The ID of project in which Langflow is created

binding.langflow.langflow_version

string | null

The version of the Langflow tool binded

binding.langflow.connections

Connections · object

details of the credential connections of the Langflow tool

Response

Successful Response

The response is of type Response Create A Tool V1 Tools Post · object.

Release Notes

Get Started

Build

Analyze

watsonx Orchestrate Developer Edition

watsonx Orchestrate MCP Server

Reference

Legal notices

Authorizations

Body

Response