Skip to main content
POST
Register a custom tool

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json

The tool definition.

The tool definition.

name
string
required

Lowercase snake_case tool slug.

Required string length: 3 - 64
description
string
required
Required string length: 1 - 1000
json_schema
object

Optional JSON Schema for the tool's arguments.

executor_url
string<uri>

HTTPS endpoint invoked on dispatch — required when execution_mode is webhook.

Maximum string length: 2000
executor_secret
string

Shared secret sent with each webhook call; stored encrypted, never echoed.

Required string length: 8 - 512
enabled
boolean
default:true
timeout_ms
integer
default:30000
Required range: 1000 <= x <= 60000
confirmation
enum<string>
Available options:
never,
always
execution_mode
enum<string>
default:webhook
Available options:
webhook,
client

Response

The created custom tool.

The created custom tool.

data
object

The registered tool (secret redacted to a set flag).

meta
object