Skip to main content
POST
/
api
/
v1
/
tools
/
register
Error
A valid request URL is required to generate request examples
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Project-ID
string
required

Project ID

Body

application/json

Request to register a tool definition

​
id
string
required

Tool ID

​
deployment_id
string | null

Deployment ID (optional, uses latest if not provided)

​
description
string | null

Tool description

​
metadata
any

Tool metadata

​
parameters
any

Tool parameters schema

​
tool_type
string | null

Tool type

Response

Tool registered successfully

Response for tool registration

​
success
boolean
required

Whether registration was successful