Skip to main content
POST
Test a custom tool with a sample call

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

Path Parameters

id
string
required

The custom tool id.

Required string length: 1 - 200

Body

application/json

Sample arguments plus optional overrides.

Sample arguments plus optional overrides.

args
object

Arguments to post to the executor.

override_executor_url
string<uri>
Maximum string length: 2000
override_executor_secret
string
Required string length: 8 - 512
override_timeout_ms
integer
Required range: 1000 <= x <= 60000

Response

The executor's live response for the sample call.

The executor's live response for the sample call.

data
object
meta
object