Register a custom tool
Register a new custom tool an agent can call mid-conversation: a lowercase snake_case name, a description the LLM reads, an optional JSON Schema for the arguments, and how the tool executes — a webhook call to your executor_url, or a client-side call the SDK returns to the caller. Webhook executor URLs are validated at write time (HTTPS only, public host, DNS-checked against SSRF), and the shared executor secret is stored encrypted and never echoed. Reserved names built into the platform are rejected.
Authorizations
Dashboard JWT token from Clerk
Headers
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.
1 - 255Sandbox 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.
true, false Body
The tool definition.
The tool definition.
Lowercase snake_case tool slug.
3 - 641 - 1000Optional JSON Schema for the tool's arguments.
HTTPS endpoint invoked on dispatch — required when execution_mode is webhook.
2000Shared secret sent with each webhook call; stored encrypted, never echoed.
8 - 5121000 <= x <= 60000never, always webhook, client