Skip to main content
POST
Node.js

Authorizations

x-api-key
string
header
required

Body

application/json
videoIds
string[]
required

Array of YouTube video IDs or URLs

Example:
playlistId
string

YouTube playlist URL or ID. See supported URL formats.

Examples:

"https://www.youtube.com/playlist?list=PLlaN88a7y2_plecYoJxvRFTLHVbIVAOoc"

"PLlaN88a7y2_plecYoJxvRFTLHVbIVAOoc"

channelId
string

YouTube channel URL, handle or ID. See supported URL formats.

Examples:

"https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw"

"https://youtube.com/c/rickastley"

"UCuAXFkgsw1L7xaCfnd5JJOw"

"@rickastley"

"rickastley"

limit
number
default:10

Maximum number of videos to process (when using playlistId or channelId)

Required range: 1 <= x <= 5000
Example:

20

lang
string

Preferred language code of the transcript (ISO 639-1). If not provided, the first available language will be returned. If the requested language is unavailable, the API defaults to the first available language. See Languages.

Example:

"en"

text
boolean
default:false

When true, returns plain text transcript.

Response

Successfully created a batch job

jobId
string
required

The ID of the job

Example:

"123e4567-e89b-12d3-a456-426614174000"