Skip to main content
POST
Generate a journey draft from a prompt

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
intent
string
required
Required string length: 8 - 4000
available_channels
enum<string>[]

Restrict send nodes to channels the tenant has connected; defaults to the standard six-channel set.

Available options:
sms,
rcs,
whatsapp,
email,
push,
voice
tone
string
Maximum string length: 120

Response

The draft journey definition plus an optional activation simulation and the generating model id.

The draft journey definition plus an optional activation simulation and the generating model id.

data
object
meta
object