Transcribe a video for dialogue editing

Starts a word-level transcription of a window of a video, the first step of a dialogue edit. Provide exactly one of sourceVideoUrl or sourceAudioUrl, both hosted in sync. storage (upload via POST /v2/assets/upload). Passing pre-extracted audio skips the server-side download and transcode. Poll GET /v2/transcriptions/{id} until status is COMPLETED, then pass the transcript and your edits to POST /v2/dialogue-edits. An identical source and window returns the existing job instead of starting a new one. Transcription is not billed.

Authentification

x-api-keystring

Authentification par clé API via en-tête

Requête

This endpoint expects an object.

sourceVideoUrlstringOptionnel

URL of the source video, hosted in sync. storage (upload it via POST /v2/assets/upload first). Provide exactly one of sourceVideoUrl or sourceAudioUrl.

sourceAudioUrlstringOptionnel

URL of audio already extracted from the source, hosted in sync. storage. Skips the server-side audio extraction. Provide exactly one of sourceVideoUrl or sourceAudioUrl.

startMsintegerOptionnel

Start of the window to transcribe, in milliseconds from the start of the source. Defaults to 0.

endMsintegerOptionnel

End of the window to transcribe, in milliseconds from the start of the source. Omit to transcribe to the end. The window cannot exceed 60 minutes.

maxSourceSecondsintegerOptionnel

Refuse the source if it is longer than this many seconds. Useful when a later step, such as a dialogue edit (10 minute window), cannot consume a longer transcript. Cannot exceed the endpoint ceiling of 3600 seconds.

projectIdstringOptionnel

Optional id of a project in your organization to file the job under.

Réponse

Transcription job created successfully

idstring

Job id. Poll GET /v2/transcriptions/{id} with it.

statusenum

Job status. COMPLETED and FAILED are terminal.

Valeurs autorisées:

sourceStartMsinteger

Start of the transcribed window, in source milliseconds.

createdAtdatetime

When the job was created.

sourceVideoUrlstringOptionnel

The source video the job was created from. Null for jobs created from sourceAudioUrl.

sourceEndMsintegerOptionnel

End of the transcribed window, in source milliseconds. Null when the job transcribes to the end of the source.

transcriptobjectOptionnel

Word-level transcript. Word timings are in milliseconds from the start of the source video, not the window. Null until status is COMPLETED.

speakerCountintegerOptionnel

Number of distinct speakers detected. Dialogue edits currently support a single speaker; a count above 1 completes the job but a dialogue edit of that source is unsupported. Null until status is COMPLETED.

difficultyobjectOptionnel

Informational estimate of how hard the source is to edit cleanly, with the reasons behind it. Null while the job is running and for some older jobs. Do not gate behaviour on it.

errorobjectOptionnel

Why the job failed. Null unless status is FAILED.

startedAtdatetimeOptionnel

When the job started processing. Null until it starts.

finishedAtdatetimeOptionnel

When the job reached a terminal status. Null until it finishes.

Erreurs

401

Unauthorized Error

402

Payment Required Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error