Sign in

v1

latestOpenAPI 3.0.42026-07-2271315.1 KB
Transcription API

Get Transcription Task

Retrieve the status and results of a transcription task. Keep polling while the status is PENDING, RECEIVED, STARTED, or PROGRESS. When the status is SUCCESS, the data object is populated.

get/open/partner/ai/transcriptions/{transcription_id}

Path parameters

transcription_idstring required

The transcription_id returned when the audio was submitted.

Response

Transcription status and results

transcription_idstring
status'PENDING' | 'RECEIVED' | 'STARTED' | 'PROGRESS' | 'SUCCESS' | 'FAILURE' | 'REVOKED'

PENDING, RECEIVED, STARTED, PROGRESS indicate the task is in progress — keep polling. SUCCESS means the data is ready. FAILURE and REVOKED are terminal failures.

Example response

{
  "transcription_id": "task_exec_xxx",
  "status": "PENDING",
  "data": {
    "results": [
      {
        "end": 4.2,
        "text": "Meeting started at 10am.",
        "speaker_id": "Speaker 1",
        "language": "en-US"
      }
    ]
  }
}