Skip to main content
GET
Get a transcription job by ID

Authorizations

Authorization
string
header
required

Your Vook API key (mint one from the web app).

Path Parameters

id
string
required

Transcription job ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

200 - application/json

Transcription job metadata + produced transcription ids

id
string
required

Transcription job ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

status
enum<string>
required

Job lifecycle status

Available options:
queued,
processing,
completed,
failed
Example:

"completed"

language
string
required

Language code as requested. Reads 'auto' when detection was requested; the transcription carries the detected code.

Example:

"auto"

diarize
boolean
required

Whether diarization was requested

Example:

false

created_at
string<date-time>
required

When the job was created

Example:

"2024-01-15T10:30:00.000Z"

updated_at
string<date-time>
required

When the job was last updated

Example:

"2024-01-15T10:30:00.000Z"

name
string | null

Display name for the job

Example:

"Team weekly sync"

transcription_id
string | null

ID of the transcription this job produced. Read it via GET /api/v1/transcriptions/:id. Null until the job reaches processing.

Example:

"123e4567-e89b-12d3-a456-426614174000"

callback_url
string | null

The endpoint this job notifies when it resolves, as submitted. Null when the job was submitted without one.

Example:

"https://example.com/vook/webhook"

error_code
string | null

Failure code when the job failed

Example:

null