Skip to main content
POST
Translate template copy into locales

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
body
string
required

Source template body to translate.

Required string length: 1 - 8000
targetLocales
string[]
required

BCP-47 target locales, e.g. ['fr', 'pt-BR'].

Required array length: 1 - 25 elements
Required string length: 2 - 10
subject
string

Optional source subject line (email).

Maximum string length: 2000
sourceLocale
string
default:en

BCP-47 locale the source is written in; echoed back as the default variant.

Required string length: 2 - 10
channel
enum<string>

Channel hint enforcing per-channel length norms.

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

Brand tone hint, e.g. 'formal' or 'friendly'.

Maximum string length: 120

Response

One variant per requested locale plus the source as the default variant.

One variant per requested locale plus the source as the default variant.

data
object
meta
object