read a transcription
transcriptions_getRetrieve a transcription job by ID to check status and, when complete, read transcript segments, speaker details, timing, revision, and source URL; wait for completion or inspect failure errors.
Instructions
Read one transcription job by id. Returns:
status: PENDING, PROCESSING, COMPLETED or FAILED.
Once COMPLETED, transcript.segments, each with an id and words. A word has text, startMs and endMs in milliseconds from the start of the source (not of the transcribed window), and a speakerId that is null or absent when unknown.
speakerCount, a top-level field beside transcript.
revision (once there is a transcript) and sourceVideoUrl (null for an audio source), which transcriptions_analyze-speakers takes.
On FAILED, error.code. NO_AUDIO, NO_AUDIO_TRACK and SOURCE_TOO_LONG will not succeed on retry.
While running, estimate.estimatedFinishAt may give an expected finish. estimate is null or absent when there is too little history. Use it after transcriptions_create. id is the UUID that call returned: a malformed id is a 400 error, and a well-formed id not in the current organization is a 404. With wait: true the server keeps reading for up to about 50 seconds and returns once the job is COMPLETED or FAILED. If it is still running, call again with wait: true; never start another transcription to check progress. Not for Edit Dialogue transcriptions (dialogue-transcriptions_get, when available) or face matches (transcriptions_get-speaker-analysis). jobs_get and jobs_wait with kind transcription, when available, read the same job with the cross-kind statuses.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Transcription id from transcriptions_create. | |
| wait | No | Wait on the server until the job finishes or about 50 seconds pass, then return its latest state. If it is still running, call again with wait: true instead of sleeping. |