> For the documentation index, fetch https://sync.so/docs/llms.txt. Append .md to a page URL for Markdown. Documentation-search MCP: https://sync.so/docs/_mcp/server.

# Get a dialogue edit job

GET https://api.sync.so/v2/dialogue-edits/{id}

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.

Reference: https://sync.so/docs/api-reference/api/dialogue-edits-api/get

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Servers

- `https://api.sync.so` (Default, default)
- `https://dev-api.sync.so` (dev)
- `http://localhost:3001` (local)

## Request

### Path parameters

- `id` (string, required) — Dialogue edit job id.

## Response

### 200

Dialogue edit job retrieved successfully

- `id` (string, required) — Job id. Poll GET /v2/dialogue-edits/\{id} with it.
- `status` (enum, 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.
  - Allowed values: `PENDING`, `PROCESSING`, `COMPLETED`, `COMPLETED_PARTIAL`, `FAILED`
- `sourceVideoUrl` (string, required) — The source video the job was created from.
- `sourceStartMs` (integer, required) — Start of the edited window, in source milliseconds.
- `edits` (list of DialogueEditOperation, required) — The edits that were applied, exactly as submitted.
- `segmentLipsyncEnabled` (boolean, 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.
- `sectionExpansionEnabled` (boolean, 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.
- `createdAt` (datetime, required) — When the job was created.
- `sourceEndMs` (integer, optional) — End of the edited window, in source milliseconds. Null when the job runs to the end of the source.
- `previewAudioUrl` (string, optional) — 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.
- `previewAssetId` (string, optional) — 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`.
- `previewDurationMs` (integer, optional) — 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.
- `sourceTranscript` (Transcript, optional) — The transcript the edits were made against, exactly as submitted. Returned in every status.
- `resultTranscript` (Transcript, optional) — The transcript as it reads after the edits, with every word timed against the preview audio. Null until the job completes.
- `resultSlots` (list of DialogueEditResultSlot, optional) — 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.
- `voiceId` (string, optional) — 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.
- `error` (DialogueEditError, optional) — Why the job failed. Null unless status is FAILED.
- `startedAt` (datetime, optional) — When the job started processing. Null until it starts.
- `finishedAt` (datetime, optional) — When the job reached a terminal status. Null until it finishes.

## Errors

### 401 Unauthorized Error

Unauthorized - Invalid or missing authentication

- `message` (GenerationErrorMessage, required) — A message describing the error.
- `statusCode` (double, required) — The type of error that occurred.
- `errorCode` (string, optional) — Stable, machine-readable error code (e.g. project_not_found, voice_not_found, concurrency_limit_reached). Branch your error handling on this, not on the message text. The full catalog of codes with messages and suggested fixes is served unauthenticated at GET /v2/errors.
- `suggestion` (string, optional) — A suggested fix an agent can act on.
- `field` (string, optional) — The request field the error refers to, when the failure is tied to a specific field (e.g. projectId, voiceId, input[].assetId).
- `docsUrl` (string, optional) — Link to the documentation page for the failing operation.
- `requestId` (string, optional) — Present on unexpected 500 responses. Include it when contacting support so the failing request can be located directly.
- `generationId` (string, optional) — Original generation ID when available for an uncertain keyed submission. Poll this ID; do not create another action to bypass IDEMPOTENCY_OUTCOME_UNKNOWN.
- `dialogueEditSection` (DialogueEditRetimeFailureSection, optional) — For dialogue_edit_removal_too_large: the section to change, when it can be identified. Create a new dialogue edit preview before submitting again.

### 404 Not Found Error

Job not found

- `message` (GenerationErrorMessage, required) — A message describing the error.
- `statusCode` (double, required) — The type of error that occurred.
- `errorCode` (string, optional) — Stable, machine-readable error code (e.g. project_not_found, voice_not_found, concurrency_limit_reached). Branch your error handling on this, not on the message text. The full catalog of codes with messages and suggested fixes is served unauthenticated at GET /v2/errors.
- `suggestion` (string, optional) — A suggested fix an agent can act on.
- `field` (string, optional) — The request field the error refers to, when the failure is tied to a specific field (e.g. projectId, voiceId, input[].assetId).
- `docsUrl` (string, optional) — Link to the documentation page for the failing operation.
- `requestId` (string, optional) — Present on unexpected 500 responses. Include it when contacting support so the failing request can be located directly.
- `generationId` (string, optional) — Original generation ID when available for an uncertain keyed submission. Poll this ID; do not create another action to bypass IDEMPOTENCY_OUTCOME_UNKNOWN.
- `dialogueEditSection` (DialogueEditRetimeFailureSection, optional) — For dialogue_edit_removal_too_large: the section to change, when it can be identified. Create a new dialogue edit preview before submitting again.

### 500 Internal Server Error

Internal Server Error - An unexpected failure on our side. The body carries errorCode internal_error and a requestId; include the requestId when contacting support.

- `message` (GenerationErrorMessage, required) — A message describing the error.
- `statusCode` (double, required) — The type of error that occurred.
- `errorCode` (string, optional) — Stable, machine-readable error code (e.g. project_not_found, voice_not_found, concurrency_limit_reached). Branch your error handling on this, not on the message text. The full catalog of codes with messages and suggested fixes is served unauthenticated at GET /v2/errors.
- `suggestion` (string, optional) — A suggested fix an agent can act on.
- `field` (string, optional) — The request field the error refers to, when the failure is tied to a specific field (e.g. projectId, voiceId, input[].assetId).
- `docsUrl` (string, optional) — Link to the documentation page for the failing operation.
- `requestId` (string, optional) — Present on unexpected 500 responses. Include it when contacting support so the failing request can be located directly.
- `generationId` (string, optional) — Original generation ID when available for an uncertain keyed submission. Poll this ID; do not create another action to bypass IDEMPOTENCY_OUTCOME_UNKNOWN.
- `dialogueEditSection` (DialogueEditRetimeFailureSection, optional) — For dialogue_edit_removal_too_large: the section to change, when it can be identified. Create a new dialogue edit preview before submitting again.

## Types

### DialogueEditOperation

A single edit: change replaces one word, remove cuts a contiguous run of words.

- `kind`: `change`
  - `replacement` (string, required) — The text to speak in place of the word.
  - `wordId` (string, required) — The id of the word to replace, from the submitted transcript.
- `kind`: `remove`
  - `wordIds` (list of string, required) — The ids of the words to cut, from the submitted transcript.

### Transcript

A word-level transcript. Word timings are in milliseconds from the start of the source video.

- `segments` (list of TranscriptSegment, required) — The transcript segments, in order.
- `speakerCount` (integer, required) — The number of distinct speakers detected.

### DialogueEditResultSlot

An edited region, located on the preview timeline and in the source video. Everything between two slots is untouched source.

- `kind` (enum, required) — The kind of edit this region represents.
  - Allowed values: `change`, `removal`, `silence`
- `outputStartMs` (integer, required) — Start of the region on the preview timeline, in milliseconds.
- `outputDurationMs` (integer, required) — Length of the region on the preview timeline, in milliseconds; 0 for a pure cut.
- `sourceStartMs` (integer, optional) — Start of the region in the source video, in absolute milliseconds.
- `sourceDurationMs` (integer, optional) — Length of the region in the source video, in milliseconds.

### DialogueEditError

Why a dialogue edit job failed. Present only when status is FAILED.

- `code` (enum, required) — Machine-readable failure code. EDIT_TOO_LONG, SOURCE_TOO_LONG, VOICE_SAMPLE_TOO_SHORT and PLAN_FAILED describe the request and will not succeed on retry.
  - Allowed values: `EXTRACTION_FAILED`, `VOICE_CLONE_FAILED`, `VOICE_SAMPLE_TOO_SHORT`, `SYNTHESIS_FAILED`, `EDIT_TOO_LONG`, `SOURCE_TOO_LONG`, `PLAN_FAILED`, `TIMEOUT`, `UNKNOWN`
- `message` (string, required) — Human-readable summary of the failure.
- `spanText` (string, optional) — For EDIT_TOO_LONG: the replacement text that does not fit the time its span has to occupy. Shorten it and resubmit.

### GenerationErrorMessage

A message describing the error.

### DialogueEditRetimeFailureSection

The dialogue-edit section that removes too much speech to stay in sync.

- `slotIndex` (integer, required) — Zero-based index of the section in the preview's `resultSlots`.
- `sourceStartMs` (integer, optional) — Start of the section in the source video, in absolute milliseconds.
- `sourceDurationMs` (integer, optional) — Length of the section in the source video, in milliseconds.

### TranscriptSegment

A run of words attributed to one speaker turn.

- `id` (string, required) — The segment id.
- `words` (list of TranscriptWord, required) — The words in the segment, in order.

### TranscriptWord

A single transcribed word with its timing in the source.

- `id` (string, required) — The word id. Dialogue edits name words by this id.
- `text` (string, required) — The transcribed text of the word.
- `startMs` (integer, required) — Start of the word, in milliseconds from the start of the source.
- `endMs` (integer, required) — End of the word, in milliseconds from the start of the source.

## Examples

**Response**

```json
{
  "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"
}
```

**SDK Code**

```python
import requests

url = "https://api.sync.so/v2/dialogue-edits/7644754c-bdfc-4d51-a78f-e0cb0cbbd40f"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.sync.so/v2/dialogue-edits/7644754c-bdfc-4d51-a78f-e0cb0cbbd40f';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sync.so/v2/dialogue-edits/7644754c-bdfc-4d51-a78f-e0cb0cbbd40f"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sync.so/v2/dialogue-edits/7644754c-bdfc-4d51-a78f-e0cb0cbbd40f")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.sync.so/v2/dialogue-edits/7644754c-bdfc-4d51-a78f-e0cb0cbbd40f")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sync.so/v2/dialogue-edits/7644754c-bdfc-4d51-a78f-e0cb0cbbd40f', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sync.so/v2/dialogue-edits/7644754c-bdfc-4d51-a78f-e0cb0cbbd40f");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sync.so/v2/dialogue-edits/7644754c-bdfc-4d51-a78f-e0cb0cbbd40f")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```