Skip to main content
POST
/
v1
/
tools
Register Tool
curl --request POST \
  --url https://api.example.com/v1/tools \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "parameters_schema": {},
  "execution_mode": "sync",
  "webhook_url": "<string>",
  "timeout_seconds": 10,
  "max_retries": 1
}
'
{}

Headers

​
authorization
string | null

Body

application/json
​
name
string
required
Required string length: 1 - 128
Pattern: ^[a-z_][a-z0-9_]*$
​
description
string
required
Required string length: 1 - 1024
​
parameters_schema
Parameters Schema · object
​
execution_mode
string
default:sync
Pattern: ^(sync|async)$
​
webhook_url
string | null
​
timeout_seconds
integer
default:10
Required range: 1 <= x <= 300
​
max_retries
integer
default:1
Required range: 0 <= x <= 5

Response

Successful Response

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