Skip to main content
GET
Retrieve the current state of a transcription job

Authorizations

Authorization
string
header
required

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

Path Parameters

job_id
string
required

The unique identifier of the transcription job

Query Parameters

response_format
enum<string>

Format for the response

Available options:
json,
markdown
include_metadata
boolean
default:false

Include the file's user-defined metadata and source metadata. In markdown these render as a ## Metadata section; in JSON they populate file.metadata and file.source_metadata.

Response

Successful response with job details

job_id
string
required
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed,
not_applicable
url
string

The URL of the processed video

created_at
integer

Unix timestamp in milliseconds when the job was created

transcribe_config
object

Configuration for rich transcription from videos

data
object
error
string

Error message if status is 'failed'

file
object

The file this document describes. metadata and source_metadata are only included when include_metadata is true.