preview dialogue edits
dialogue-previews_createGenerate an audio preview of user-approved transcript word changes and removals in the original speaker voice, so you can review edits before producing the final video.
Instructions
Start an Edit Dialogue audio preview: re-synthesize user-approved word changes and removals from a saved single-speaker video's transcript in the original speaker voice, returning the preview job (id, status). Not for translation (dubbing_create), another voice or a new full script (lipsync_create with a script, or speech-previews_create), or the final video (dialogue-videos_create). May clone the source speaker voice and incur synthesis charges; confirm the edits and permission to use that voice before creating. The tool first checks that the transcription (COMPLETED) or previous preview (COMPLETED or COMPLETED_PARTIAL) was made from this source video, and fails otherwise; it adds a preview job and never overwrites the source. Next, poll dialogue-previews_get with the id and disclose any COMPLETED_PARTIAL shortfall; after the user approves the audio, quote the final video with dialogue-videos_estimate. When dialogue_get-options reports keyedPreview, persist an idempotencyKey before creating (sending one otherwise fails); recover only through an explicit retry of identical input with that same key, and never retry an ambiguous creation automatically. With projectId, projectIntent=explicit is required; default new work to a new project.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| edits | Yes | The complete list of user-approved changes/removals for this preview (1 to 100), including earlier ones to keep when revising. Word ids come from the COMPLETED transcription's transcript, or from the previous preview's sourceTranscript, never its resultTranscript. | |
| projectId | Yes | Project for the preview, the one used for the transcription. Keep unchanged on retries. Default new work to a new project: the id projects_create returned for this request (defaultWorkflow edit_dialogue). Use an existing project only when the user explicitly chose it, and then pass projectIntent=explicit. | |
| videoAssetId | Yes | Saved VIDEO asset for the transcription or prior preview, accessible to the connected account. | |
| projectIntent | No | Required with projectId. Set only for an explicit user project selection/update, or the new project just created for this request. Never infer intent from a matching project name, workflow name or active editor. | |
| idempotencyKey | No | Persist a unique key before creation when dialogue_get-options reports keyedPreview. Reuse only with identical inputs for an explicitly requested retry. | |
| organizationId | No | Run only this call in another of the user’s Sync organizations, by id from organizations_list, when the user asks for it (for example “generate this in the Acme org”). The session keeps its organization; reads of the ids this call returns stay in this organization. Omit to use the session’s organization. | |
| transcriptionId | No | Deprecated alias of transcriptionJobId. | |
| previousPreviewId | No | Id of a COMPLETED or COMPLETED_PARTIAL preview of this source, to revise it. Its sourceTranscript and cloned voice are reused, but its edits are not carried over, so edits must be the full set you want; sending the same edits again reruns it. Supply exactly one of previousPreviewId or transcriptionJobId. | |
| transcriptionJobId | No | Id from dialogue-transcriptions_create, for a first preview; that transcription must be COMPLETED. Supply exactly one of transcriptionJobId or previousPreviewId. |