{
"openapi": "3.0.1",
"info": {
"title": "YouTube Transcript Scraper - Subtitles & Captions API",
"description": "Get transcripts of YouTube videos, Shorts, whole channels, playlists or search results: full text, timestamped segments and SRT or VTT files, in the video's language or every language it has. Creator subtitles first, auto-generated as backup. No API key.",
"version": "0.0",
"x-build-id": "Kpw8PqaZU1UYl79Jl"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/delicious_zebu~youtube-transcript-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-delicious_zebu-youtube-transcript-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/delicious_zebu~youtube-transcript-scraper/runs": {
"post": {
"operationId": "runs-sync-delicious_zebu-youtube-transcript-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/delicious_zebu~youtube-transcript-scraper/run-sync": {
"post": {
"operationId": "run-sync-delicious_zebu-youtube-transcript-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"properties": {
"urls": {
"title": "YouTube video links",
"uniqueItems": true,
"type": "array",
"description": "Video, Shorts or live links, or the 11-character video ID, one per line. Example: https://youtu.be/aircAruvnKk or just aircAruvnKk. Each video is processed only once.",
"items": {
"type": "string"
}
},
"channels": {
"title": "Channels",
"type": "array",
"description": "Channel handle, channel link or channel ID (starts with UC), one per line. Example: @3blue1brown, https://www.youtube.com/@LinusTechTips or UCYO_jab_esuFRV4b17AJtAw.",
"items": {
"type": "string"
}
},
"channel_tab": {
"title": "Channel tab",
"enum": [
"videos",
"shorts",
"streams"
],
"type": "string",
"description": "Which tab of the channel page to take videos from: Videos, Shorts or Live (past live streams), like the tabs under the channel name on YouTube. Members-only videos are not included. A channel link that ends in /shorts or /streams uses that tab.",
"default": "videos"
},
"max_videos_per_channel": {
"title": "Max videos per channel",
"minimum": 0,
"type": "integer",
"description": "How many of the newest videos to take from each channel. Use 0 for all of them.",
"default": 20
},
"playlists": {
"title": "Playlists",
"type": "array",
"description": "Playlist links (or playlist IDs), one per line. Example: https://www.youtube.com/playlist?list=PLZHQObOWTQDNU6R1_67000Dx_ZCJB-3pi. Mix playlists (YouTube's auto-generated radio) can't be listed.",
"items": {
"type": "string"
}
},
"max_videos_per_playlist": {
"title": "Max videos per playlist",
"minimum": 0,
"type": "integer",
"description": "How many videos to take from each playlist, from the top. Use 0 for the whole playlist.",
"default": 20
},
"search_keywords": {
"title": "Search terms or search result links",
"type": "array",
"description": "One per line. A search term finds videos only (YouTube's Type: Video filter), in YouTube's order. To use filters such as upload date or duration, search on YouTube, set the filters and paste the results page link. Example: neural networks explained, or https://www.youtube.com/results?search_query=bread+recipe&sp=EgIIAw%253D%253D (uploaded this week).",
"items": {
"type": "string"
}
},
"max_videos_per_search": {
"title": "Max videos per search",
"minimum": 0,
"type": "integer",
"description": "How many of the top videos to take from each search. Use 0 to take every result YouTube shows.",
"default": 20
},
"language": {
"title": "Subtitle language",
"enum": [
"original",
"all",
"ab",
"aa",
"af",
"ak",
"sq",
"am",
"ar",
"hy",
"as",
"ay",
"az",
"bn",
"ba",
"eu",
"be",
"bho",
"bs",
"br",
"bg",
"my",
"ca",
"ceb",
"zh-Hans",
"zh-Hant",
"co",
"hr",
"cs",
"da",
"dv",
"nl",
"dz",
"en",
"eo",
"et",
"ee",
"fo",
"fj",
"fil",
"fi",
"fr",
"gaa",
"gl",
"lg",
"ka",
"de",
"el",
"gn",
"gu",
"ht",
"ha",
"haw",
"iw",
"hi",
"hmn",
"hu",
"is",
"ig",
"id",
"iu",
"ga",
"it",
"ja",
"jv",
"kl",
"kn",
"kk",
"kha",
"km",
"rw",
"ko",
"kri",
"ku",
"ky",
"lo",
"la",
"lv",
"ln",
"lt",
"lua",
"luo",
"lb",
"mk",
"mg",
"ms",
"ml",
"mt",
"gv",
"mi",
"mr",
"mn",
"mfe",
"ne",
"new",
"nso",
"no",
"ny",
"oc",
"or",
"om",
"os",
"pam",
"ps",
"fa",
"pl",
"pt",
"pt-PT",
"pa",
"qu",
"ro",
"rn",
"ru",
"sm",
"sg",
"sa",
"gd",
"sr",
"crs",
"sn",
"sd",
"si",
"sk",
"sl",
"so",
"st",
"es",
"su",
"sw",
"ss",
"sv",
"tg",
"ta",
"tt",
"te",
"th",
"bo",
"ti",
"to",
"ts",
"tn",
"tum",
"tr",
"tk",
"uk",
"ur",
"ug",
"uz",
"ve",
"vi",
"war",
"cy",
"fy",
"wo",
"xh",
"yi",
"yo",
"zu"
],
"type": "string",
"description": "The same languages as Settings → Subtitles/CC in the YouTube player. Original language is the language spoken in the video, the one Show transcript opens. All languages returns every subtitle track the video has, one result per language. Subtitles from the creator are used before auto-generated captions. A video that doesn't have the language you pick is skipped and not charged. YouTube's auto-translate is not available.",
"default": "original"
},
"include_auto_generated": {
"title": "Include auto-generated captions",
"type": "boolean",
"description": "Captions YouTube makes from the speech, shown as \"(auto-generated)\" in the Subtitles/CC menu. Subtitles from the creator are always used first. Turn this off to get only subtitles uploaded by the creator.",
"default": true
},
"subtitle_format": {
"title": "Subtitle file",
"enum": [
"none",
"srt",
"vtt"
],
"type": "string",
"description": "Also put the whole subtitle file, as text, in the subtitles field, ready to save as an .srt or .vtt file.",
"default": "none"
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}