GET/youtube/transcriptDeprecated

Get a YouTube video transcript

Retrieves a transcript for a YouTube video, with options for language, chunk size, and plain-text output. Provide the video URL or ID and use lang to request a preferred ISO 639-1 language; if that language is unavailable, the first available language is used. This operation is closing down and will be removed on a date not specified.

5 parameters
urlstringoptional
YouTube video URL in a supported format.
videoIdstringoptional
YouTube video ID. Use this as an alternative to `url`.
textbooleanoptional
Set to `true` to return the transcript as plain text. Defaults to `false` when omitted.
Default:false
chunkSizenumberoptional
Maximum characters per transcript chunk when `text` is `false`. Must be between 50 and 10000.
langstringoptional
Preferred transcript language as an ISO 639-1 language code. Defaults to the first available language when omitted or when the requested language is unavailable.

5 status codes
200Returns the transcript content as text or chunks, the language code used, and the available transcript language codes.
contentarray<object>required
langstringrequired
ISO 639-1 language code of transcript
availableLangsarray<string>required
List of available language codes
206Returns an error response indicating that the transcript is unavailable.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
400Returned when the request is invalid; the response includes an error code, message, and details.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
404Returned when the requested video cannot be found; the response includes an error code, message, and details.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
500Returned when an internal error occurs; the response includes an error code, message, and details.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation

Error handling

A 400 is returned when the request is invalid; url must be a URI when supplied, and chunkSize must be between 50 and 10000. A 404 is returned when the requested video cannot be found. A 500 is returned when an internal error occurs; if the requested transcript language is unavailable, the API uses the first available language.