Skip to main content
POST
cURL
Submit a YouTube video for transcription. The request returns immediately with a projectId; the actual transcription runs in the background — see Lifecycle & Polling.

Request

Credit is deducted at request time based on the video’s reported length: 1 credit per minute (rounded down, minimum 1). If the YouTube video is unavailable or private, the request fails before any credit is consumed.

Examples

Response

201 Created:

Errors

What happens next

  1. Project is created in upload state.
  2. We download the video, then transcribe its audio.
  3. State moves to transcription, then to done.
  4. If you supplied webhookUrl, we POST the result to it. Either way, GET /api/detail/{id} will return the full transcription once state is done.

Authorizations

api-key
string
header
required

Body

application/json
language
string
required

The language of the video

Example:

"en"

webhookUrl
string
required

The URL to send the transcription results to

Example:

"http://example.com/webhook"

youtubeVideoId
string
required

The ID of the YouTube video

Example:

"dQw4w9WgXcQ"

Response

Project created and queued for transcription

success
boolean
required
Example:

true

projectId
string<uuid>
required
Example:

"f3c1e7a0-2b48-4a91-8a30-9b1c2d3e4f50"