Skip to main content
POST
Create a transcription job from an uploaded file or a URL

Authorizations

Authorization
string
header
required

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

Body

application/json
language
string
required

Spoken language code, such as 'en' or 'fr'. Send 'auto' to let us detect it; the transcription then reports the detected code.

Example:

"auto"

diarize
boolean
required

Whether to diarize (separate speakers)

Example:

false

upload_token
string

Upload token returned by POST /api/v1/uploads/init. Send either upload_token or url.

url
string

Direct https link to an audio or video file, such as a presigned object URL. We fetch it for you. Send either upload_token or url.

Maximum string length: 2048
Example:

"https://example.com/recordings/meeting.mp3"

file_name
string

Original file name. Required with upload_token, optional with url.

Example:

"meeting.mp3"

name
string

Display name for the resulting transcription(s)

Maximum string length: 255
Example:

"Team weekly sync"

callback_url
string

Webhook endpoint notified once, when the job reaches a terminal status. Public https, standard port. Omit it to poll instead.

Maximum string length: 2048
Example:

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

Response

Transcription job created

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:

"queued"