How this differs from generic translation APIs
Billing is by source character count (all
segments[].text), not by duration. See Pricing.Request shape
Each segment supports:
Field-level OpenAPI detail: Create text translation (sync).
Context management
Ambiguous lines (“that”, “he”, homophones) need controlled context — not the whole document dumped in every time.Global strategy: options.sourceContext
Priority: segment-level
context overrides global sourceContext for that line.
When to use which mode
- Subtitle / dubbing script in order —
neighborwith a smallcontextWindow(e.g. 3–5) for pronoun and tone continuity without leaking unrelated lines. - Cherry-picked cues or A/B takes —
provided_only+ explicitcontextper segment. - Isolated UI strings or glossary checks —
independent.
start / end with ordered segments when your pipeline already has timecodes; the API uses segment order and timing together with neighbor mode.
Scene and delivery: options.sceneCustomized
Use
subtitle for burn-in or caption constraints; voiceover or audio when the line is spoken without lip sync; video for general dubbed video dialogue.
Terminology and instructions
options.glossary— map of source term → preferred translation (brand names, character names, fixed phrases).options.prompt— extra instruction appended to the translation task (tone, audience, “keep informal”, etc.).options.skipMissingTranslationCheck— whentrue, skips validation that every segment returned a translation (advanced; defaultfalse).
Sync vs async
Every
create and create-async call requires X-Idempotency-Key. Async also needs a configured Webhook. Async-only extraData is echoed in webhooks — see Create text translation (async).
Example: multi-speaker dubbing batch
data.items in the same order as segments.
Workflow (async)
- Configure Webhooks
- POST to
create-asyncwith idempotency key - Save
taskIdfrom the acceptance response - Read translated segments from webhook
data.items
Related
- Products overview
- Pricing — credits per 100 characters of source text
- Usage limits — max 50 segments per request
- Media translation — end-to-end audio/video localization

