Skip to main content
POST
Create transcription job

Authorizations

Authorization
string
header
required

Send your API Key in the Authorization header (Bearer <api_key>). See Authentication.

Headers

X-Idempotency-Key
string
required

Required on mutating POST requests that create tasks or change persisted data (max 64 characters). See Idempotency.

Maximum string length: 64

Body

application/json
source
object
required

Exactly one of materialId or youtubeUrl. sourceUrl is not supported for transcription and returns 400.

language
object
required

Language settings

options
object

Transcription options (all optional)

title
string

Job name shown in My tasks (max 255 characters). Defaults to the file name or the YouTube video title.

Maximum string length: 255

Response

200 - application/json

Task accepted. editorUrl opens the job in the website transcription editor.

code
integer
required

Business code; 200 means success

Example:

200

message
string

Human-readable detail when code is not success

Example:

""

data
object