SYsync
Dialogue Edits

Get a dialogue edit job

Changed on

Returns the job status and, once it completed, the preview audio url, the retimed transcript and the edited regions. COMPLETED, COMPLETED_PARTIAL and FAILED are terminal; error.code says why a job failed.

get/v2/dialogue-edits/{id}

Request

  • Base URL
    https://api.sync.so
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Dialogue edit job id

Response

idstring uuid required

Job id. Poll GET /v2/dialogue-edits/{id} with it.

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'COMPLETED_PARTIAL' | 'FAILED' required

Job status. COMPLETED, COMPLETED_PARTIAL and FAILED are terminal. COMPLETED_PARTIAL means the preview is playable but shipped without something that was requested; treat it as completed.

sourceVideoUrlstring required

The source video the job was created from.

sourceStartMsinteger required

Start of the edited window, in source milliseconds.

sourceEndMsinteger nullable required

End of the edited window, in source milliseconds. Null when the job runs to the end of the source.

previewAudioUrlstring nullable required

Hosted WAV of the edited audio for the whole window: the original recording with only the edited spans re-synthesized. Null until the job completes.

previewAssetIdstring uuid nullable

Always null. To lipsync a preview, pass its id as dialogueEdit: { id } on POST /v2/generate.

previewDurationMsinteger nullable required

Length of the preview audio in milliseconds. Differs from the window length by however much the edits grew or shrank it. Null until the job completes.

segmentLipsyncEnabledboolean required

Whether the preview was cut for per-region lipsync (true) or for re-lipsyncing the whole window (false). Decided when the job is created and fixed for its lifetime. For jobs created with an API key, the rollout is evaluated against the organization's members.

sectionExpansionEnabledboolean required

Whether the preview was made under the section-expansion policy. Decided when the job is created and fixed for its lifetime. For jobs created with an API key, the rollout is evaluated against the organization's members.

voiceIdstring nullable required

Opaque id of the voice cloned from the source and used for synthesis. Pass it as voiceId on the next dialogue-edit job of the same source to skip cloning. Null until the voice exists.

createdAtstring date-time required
startedAtstring date-time nullable required
finishedAtstring date-time nullable required

Changes

  • f2122591bafbRevision changes
    • info

      added the optional property to the response with the status

  • 731f968d8555Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property // to the response with the status