get a transcription job

{
  "id": "6533643b-aceb-4c40-967e-d9ba9baac39e",
  "status": "COMPLETED",
  "sourceStartMs": 0,
  "createdAt": "2024-01-15T09:30:00Z",
  "sourceVideoUrl": "https://assets.sync.so/docs/example-video.mp4",
  "sourceEndMs": 30000,
  "transcript": {
    "segments": [
      {
        "id": "seg_1",
        "words": [
          {
            "id": "w_1",
            "text": "The",
            "startMs": 120,
            "endMs": 260,
            "confidence": 0.9921
          },
          {
            "id": "w_2",
            "text": "quarterly",
            "startMs": 260,
            "endMs": 820,
            "confidence": 0.9874
          },
          {
            "id": "w_3",
            "text": "results",
            "startMs": 820,
            "endMs": 1240,
            "confidence": 0.9958
          }
        ],
        "speakerLabelFlags": []
      }
    ],
    "speakerCount": 1
  },
  "speakerCount": 1,
  "difficulty": {
    "tier": "green",
    "reasons": []
  },
  "startedAt": "2024-01-15T09:30:02Z",
  "finishedAt": "2024-01-15T09:30:20Z"
}

Returns the job status and, once status is COMPLETED, the word-level transcript. COMPLETED and FAILED are terminal; error.code says why a job failed.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

idstringRequired

Transcription job id.

Response

Transcription job retrieved successfully

idstring

Job id. Poll GET /v2/transcriptions/{id} with it.

statusenum

Job status. COMPLETED and FAILED are terminal.

Allowed values:

sourceStartMsinteger

Start of the transcribed window, in source milliseconds.

createdAtdatetime

When the job was created.

sourceVideoUrlstringOptional

The source video the job was created from. Null for jobs created from sourceAudioUrl.

sourceEndMsintegerOptional

End of the transcribed window, in source milliseconds. A requested end past the end of the source reads as the source's end when the source could be measured at creation. Null when the job transcribes to the end of the source.

transcriptobjectOptional

Word-level transcript. Word timings are in milliseconds from the start of the source video, not the window. Null until status is COMPLETED.

speakerCountintegerOptional

Number of distinct speakers detected. Dialogue edits currently support a single speaker; a count above 1 completes the job but a dialogue edit of that source is unsupported. Null until status is COMPLETED.

difficultyobjectOptional

Informational estimate of how hard the source is to edit cleanly, with the reasons behind it. Null while the job is running and for some older jobs. Do not gate behaviour on it.

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.

revisionstringOptional

Content hash of the source and transcript this job produced. Present once the job has a transcript.

estimateobject or nullOptional

Expected completion time while the transcription is running. Null when the job is terminal or no estimate is available.

retryAfterMsintegerOptional

Milliseconds to wait before polling this job again, between 1,000 and 5,000. Present only while the job is PENDING or PROCESSING.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error