{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper - Videos, Playlists & Channels", "description": "Extract YouTube transcripts/subtitles in any language from videos, Shorts, playlists and entire channels. Plain text, timestamps, SRT and VTT, auto-translation, plus video metadata. You only pay for transcripts actually found.", "version": "1.0", "x-build-id": "rGG8KddURtmhon44L" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidelark~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidelark-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/tidelark~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-tidelark-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/tidelark~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-tidelark-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", "required": [ "videos" ], "properties": { "videos": { "title": "YouTube URLs", "type": "array", "description": "Video URLs, Shorts URLs, video IDs, playlist URLs or channel URLs/handles (e.g. https://www.youtube.com/@mkbhd or @mkbhd). Playlists and channels are expanded into their videos.", "items": { "type": "string" } }, "maxVideosPerChannel": { "title": "Max videos per playlist/channel", "minimum": 1, "maximum": 5000, "type": "integer", "description": "For playlist and channel inputs: how many videos (newest first for channels) to process.", "default": 50 }, "languages": { "title": "Preferred languages", "type": "array", "description": "Language codes in order of preference, e.g. en, es, de, nl, pt-BR.", "default": [ "en" ], "items": { "type": "string" } }, "anyLanguageFallback": { "title": "Fall back to any available language", "type": "boolean", "description": "If none of the preferred languages exist, return the transcript in whatever language is available.", "default": true }, "preferManualCaptions": { "title": "Prefer human-made captions", "type": "boolean", "description": "Prefer captions uploaded by the creator over YouTube's auto-generated ones when both exist.", "default": true }, "translateTo": { "title": "Translate to (optional)", "type": "string", "description": "Language code to auto-translate the transcript into using YouTube's built-in translation, e.g. en, es, de. Leave empty for the original language." }, "includeText": { "title": "Plain text", "type": "boolean", "description": "Full transcript as one plain-text string (ideal for AI/LLM use).", "default": true }, "includeSegments": { "title": "Segments with timestamps", "type": "boolean", "description": "Array of {start, duration, text} segments.", "default": true }, "includeTimestampedText": { "title": "Timestamped text", "type": "boolean", "description": "Readable text with [m:ss] timestamps on every line.", "default": false }, "includeSrt": { "title": "SRT subtitles", "type": "boolean", "description": "Transcript as an SRT subtitle file string.", "default": false }, "includeVtt": { "title": "WebVTT subtitles", "type": "boolean", "description": "Transcript as a WebVTT subtitle file string.", "default": false }, "includeMetadata": { "title": "Video metadata", "type": "boolean", "description": "Title, channel, duration, views, keywords, description and thumbnail.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many videos to process in parallel.", "default": 5 }, "maxRetries": { "title": "Max retries per request", "minimum": 1, "maximum": 15, "type": "integer", "description": "Retries with a fresh session/IP when YouTube blocks a request.", "default": 6 }, "residentialFallback": { "title": "Fall back to residential proxy when blocked", "type": "boolean", "description": "Automatically switch to residential proxies if YouTube keeps blocking. Recommended.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is recommended.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }