Skip to navigation

Get transcription job

View as Markdown

Returns the current state of a transcription job, and the transcript once it is done. Poll this endpoint until status is completed or error — both are terminal. Poll the same base URL you submitted to: an id the engine does not recognise returns 404.

Authentication

AuthorizationBearer

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

Path parameters

job_idstringRequired

Job id returned by POST /v1/transcription/jobs.

Response

Current job status, with the transcript once completed
idstring
Job id.
enginestring
Transcription engine that ran the job.
statusenum

pending while the job is queued or running, completed once the transcript is attached, error when the job failed terminally.

Allowed values:
errorstring or nullOptional

Set only when status is error. Terminal — stop polling.

textstring or nullOptional

Full transcript. Present once status is completed.

languagestring or nullOptional
Language the engine detected, or the one it was told to use.
utteranceslist of objectsOptional

Speaker-attributed segments. Empty unless diarization ran.

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
502
Bad Gateway Error