Get a dialogue edit job

{
  "id": "7644754c-bdfc-4d51-a78f-e0cb0cbbd40f",
  "status": "COMPLETED",
  "sourceVideoUrl": "https://assets.sync.so/docs/example-video.mp4",
  "sourceStartMs": 0,
  "edits": [
    {
      "kind": "change",
      "replacement": "annual",
      "wordId": "w_2"
    }
  ],
  "segmentLipsyncEnabled": false,
  "sectionExpansionEnabled": false,
  "createdAt": "2024-01-15T09:31:00Z",
  "sourceEndMs": 30000,
  "previewAudioUrl": "https://assets.sync.so/docs/dialogue-edit-preview.wav",
  "previewAssetId": null,
  "previewDurationMs": 29850,
  "sourceTranscript": {
    "segments": [
      {
        "id": "seg_1",
        "words": [
          {
            "id": "w_1",
            "text": "The",
            "startMs": 120,
            "endMs": 260
          },
          {
            "id": "w_2",
            "text": "quarterly",
            "startMs": 260,
            "endMs": 820
          },
          {
            "id": "w_3",
            "text": "results",
            "startMs": 820,
            "endMs": 1240
          }
        ]
      }
    ],
    "speakerCount": 1
  },
  "resultTranscript": {
    "segments": [
      {
        "id": "seg_1",
        "words": [
          {
            "id": "w_1",
            "text": "The",
            "startMs": 120,
            "endMs": 260
          },
          {
            "id": "w_2",
            "text": "annual",
            "startMs": 260,
            "endMs": 690
          },
          {
            "id": "w_3",
            "text": "results",
            "startMs": 690,
            "endMs": 1110
          }
        ]
      }
    ],
    "speakerCount": 1
  },
  "resultSlots": [
    {
      "kind": "change",
      "outputStartMs": 260,
      "outputDurationMs": 430,
      "sourceStartMs": 260,
      "sourceDurationMs": 560
    }
  ],
  "voiceId": "voice_9f2c",
  "startedAt": "2024-01-15T09:31:03Z",
  "finishedAt": "2024-01-15T09:31:48Z"
}

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.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

idstringRequired

Dialogue edit job id.

Response

Dialogue edit job retrieved successfully

idstring

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

statusenum

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.

Allowed values:

sourceVideoUrlstring

The source video the job was created from.

sourceStartMsinteger

Start of the edited window, in source milliseconds.

editslist of objects

The edits that were applied, exactly as submitted.

segmentLipsyncEnabledboolean

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

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.

createdAtdatetime

When the job was created.

sourceEndMsintegerOptional

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

previewAudioUrlstringOptional

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.

previewAssetIdstringOptional

Asset id of the registered preview after completion, when available. Null or absent before completion or for an unregistered preview. To lipsync the edit, pass the job id as dialogueEdit: { id } on POST /v2/generate.

previewDurationMsintegerOptional

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.

sourceTranscriptobjectOptional

The transcript the edits were made against, exactly as submitted. Returned in every status.

resultTranscriptobjectOptional

The transcript as it reads after the edits, with every word timed against the preview audio. Null until the job completes.

resultSlotslist of objectsOptional

The edited regions in order, each located on the preview timeline (outputStartMs, outputDurationMs) and in the source video (sourceStartMs, sourceDurationMs). Everything between two slots is untouched source. Null until the job completes.

voiceIdstringOptional

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.

errorobjectOptional

Why the job failed. Null unless status is FAILED.

startedAtdatetimeOptional

When the job started processing. Null until it starts.

finishedAtdatetimeOptional

When the job reached a terminal status. Null until it finishes.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error