render_captions
Burn the same video again from edited words. Send the job's words.json with corrections applied, every word with its startMs and endMs in order (keep confidence if you want it in the new words.json); no speech model runs, what you send is what gets burned. Optionally change the preset or the highlight colour. Free within the job's allowance (3 on a paid account, 1 on the trial) and within 24 hours of completion. Returns the job at once with render.status accepted; poll get_caption_job until it is completed, when the artifact links switch to the new version. A retry is safe only when it carries the same idempotencyKey and the same body; without a key, each accepted call reserves a re-render from the allowance. Completion spends it; failure returns it. After 3 failed re-renders the job is paused for investigation, with rerenderFailureLimitReached true; do not automatically retry. Re-renders count toward the account's concurrent job limit while they run.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| jobId | Yes | A job id returned by this API. | |
| words | Yes | The edited words.json: every word with its timing, in order. | |
| preset | No | Optional. Defaults to the job's preset. | |
| highlightColor | No | Optional, highlight preset only. The spoken word's colour as a hex RGB. Defaults to the job's colour. | |
| idempotencyKey | No | Optional. Any string unique to this request; a retry with the same key returns the same result instead of running twice. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||