Skip to main content
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 | null

A request body for a tool.

output_schema
ToolResponseBody · object | null

A response body for a tool.

binding
ToolBinding · object | null

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

tags
any[] | null
is_async
boolean
default:false

Whether the tool execution is asynchronous

restrictions
string
default:editable

Whether the tool can be edited

bundled_agent_id
string | null

Base agent id

Response

Successful Response

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