Skip to main content
POST
Create a new web tool.

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Body

application/json
type
enum<string>
required

The type of the web tool.

Available options:
FUNCTION,
MCP
Example:

"FUNCTION"

name
string
required

The name of the web tool.

Required string length: 1 - 250
Example:

"Weather API Tool"

toolSettings
object
required

Server configuration settings for the web tool.

description
string

A description of what the web tool does.

Required string length: 1 - 1000
Example:

"A tool that fetches current weather information for a given location."

async
boolean

Whether the tool should run asynchronously. Required when type is FUNCTION, not allowed when type is MCP.

Example:

true

messages
object[]

Array of message configurations for the web tool. Each message type must be unique.

Example:
params
object

Parameter schema definition for the web tool. Not allowed when type is MCP. This field is a recursive OpenAPI-style shape with 'type', 'properties', 'required', 'items', ...etc. Please refer to the OpenAPI specification for more information.

Example:

Response

Successful response

success
boolean
default:false
message
string
default:success
data
object