Skip to navigation
AudioTranscription

Media · Transcription · Poll a transcription job for status and transcript (step 2 of 3)

View as Markdown

Step 2 — poll this endpoint with the id returned by transcribeVideo.

Read job_status:

  • Non-terminal (CREATED, PENDING, PROCESSING, RENDERING, UPDATED): keep polling. A 10s interval is reasonable.
  • Terminal: DONE (success — payload.phrases is now populated with word-level timing) or FAILED (error — stop polling).

Once job_status="DONE" you can either read payload.phrases directly, or call downloadTranscriptionFile for a VTT/SRT file.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
Transcription UUID returned from transcribeVideo.

Response

Transcription record.
idstringOptional
Transcription UUID. Use this with getTranscription and downloadTranscriptionFile.
titlestringOptional
creatorintegerOptional
Creator user ID.
video_urlstringOptional
Source media URL submitted for transcription.
transcribed_video_urlstring or nullOptional

URL of the captioned/burned-in video, if produced.

transcription_urlstring or nullOptional
URL of the raw transcript artifact in storage.
payloadmap from strings to anyOptional

Transcription payload. When job_status=COMPLETED, contains language_code and phrases (each with speaker, text, and words[{text, start, end, confidence}] in milliseconds).

contentmap from strings to anyOptional

Source metadata (e.g. {source, source_id}).

job_statusenumOptional

Lifecycle state of the transcription job. Terminal: DONE (success) and FAILED. All other values are non-terminal — keep polling.

statusstringOptional

Project status (PUBLIC, PRIVATE, ARCHIVED).

project_typestringOptional
Always "transcription" for this resource.
createddatetimeOptional
modifieddatetimeOptional
translation_languagestring or nullOptional
providerenumOptional
STT engine used for the job.
Allowed values: