GET
/transcriptGet a transcript from a video or media URL
Retrieves a transcript for a video from a supported platform or a direct media file URL. Set lang, text, chunkSize, and mode to control the transcript language, format, chunking, and retrieval or generation behavior. For asynchronous processing, use GET /transcript/{jobId} with the returned job ID to check the result.
urlstringrequired
Video URL from a supported platform or a direct media file URL. Must be a URI.
langstringoptional
Preferred transcript language as an ISO 639-1 code. If omitted or unavailable, the first available language is returned.
textbooleanoptional
Set to true to return the transcript as plain text. Defaults to false when omitted.
chunkSizenumberoptional
Maximum characters per transcript chunk when `text` is false. Must be between 50 and 10000.
modestringoptional
Transcript mode: native, auto, or generate. Defaults to auto when omitted. File URLs always use generate mode.
200Returns either the transcript result, including its content, language, and available languages, or a `jobId` for asynchronous processing.
contentarray<object>required
langstringrequired
ISO 639-1 language code of transcript
availableLangsarray<string>required
List of available language codes
202Returns a `jobId` for transcript processing that will complete asynchronously.
contentarray<object>required
langstringrequired
ISO 639-1 language code of transcript
availableLangsarray<string>required
List of available language codes
206Returned when a transcript is unavailable for the requested media.
errorstringrequired
Error code identifying the type of error
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
400Returned when the request is invalid.
errorstringrequired
Error code identifying the type of error
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
401Returned when the request is unauthorized.
errorstringrequired
Error code identifying the type of error
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
402Returned when an upgrade is required.
errorstringrequired
Error code identifying the type of error
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
403Returned when the request is forbidden.
errorstringrequired
Error code identifying the type of error
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
404Returned when the requested resource is not found.
errorstringrequired
Error code identifying the type of error
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
429Returned when the request limit is exceeded.
errorstringrequired
Error code identifying the type of error
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
500Returned when an internal error occurs.
errorstringrequired
Error code identifying the type of error
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
Error handling
A 206 indicates that a transcript is unavailable, a 400 indicates an invalid request, a 401 an unauthorized request, a 402 an upgrade is required, a 403 a forbidden request, and a 404 a missing resource. A 429 indicates the request limit was exceeded, and a 500 indicates an internal error. url must be a URI, chunkSize must be between 50 and 10000 when provided, and mode must be native, auto, or generate.