Skip to main content
POST
/
v1
/
tools
Error
A valid request URL is required to generate request examples

Authorizations

Authorization
string
header
required

Org API key (scopes the request to its organization) or the shared trusted key (requires X-Organization-Id on every request).

Headers

X-Organization-Id
string

Organization to scope the request to. Optional when authenticating with an org API key (the org is taken from the key; if sent, it must match). Required when authenticating with the trusted key.

X-User-Id
string

End-user identity for the request; user-scoped data (threads, memory) resolves to {orgId}_{userId}. Required by endpoints that read or write user-scoped resources. A userId query param (or body field, where documented) is accepted as a fallback.

Body

application/json
tool_provider_id
string<uuid>
required
name
string
required
Minimum string length: 1
path
string
required
Minimum string length: 1
description
string | null
method
enum<string>
default:GET
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
input_schema
object | null
output_schema
object | null
timeout_ms
integer
Required range: 1000 <= x <= 120000
is_enabled
boolean
operation_id
string
tags
string[] | null
deprecated
boolean

Response

Created