{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper - Subtitles & Captions API", "description": "YouTube transcripts (captions/subtitles) in bulk from video URLs, playlists, channels or search queries. Returns full text, timestamped segments, optional SRT/VTT, language, word/token counts and video metadata. 100+ languages, translation. $0.002 per transcript; no captions = free.", "version": "0.1", "x-build-id": "3kUQlZKOwnb1RF8Vo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/orbifetch~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-orbifetch-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/orbifetch~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-orbifetch-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/orbifetch~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-orbifetch-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": { "sources": { "title": "Videos, playlists or channels", "type": "array", "description": "Videos to get transcripts for: video URLs or 11-character IDs, Shorts, playlist URLs, or channel URLs / @handles. Playlists and channels expand into their videos (up to maxVideosPerSource). Provide sources, searchQueries, or both.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Optional. YouTube search queries, e.g. \"python tutorial\". Returns transcripts of the top results for each query, up to maxVideosPerSource.", "items": { "type": "string" } }, "maxVideosPerSource": { "title": "Max videos per playlist / channel / search", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum videos taken from each playlist, channel or search query (1-5000, default 50). Channels list their newest videos first. Single video URLs are always included.", "default": 50 }, "languages": { "title": "Preferred languages", "type": "array", "description": "Language codes in order of preference, e.g. en, es, de. Human-made captions are preferred over auto-generated ones in the same language.", "default": [ "en" ], "items": { "type": "string" } }, "fallbackToAnyLanguage": { "title": "Fall back to any available language", "type": "boolean", "description": "If none of the preferred languages exist, return the video's original transcript instead of skipping it.", "default": true }, "allowAutoGenerated": { "title": "Allow auto-generated captions", "type": "boolean", "description": "Use YouTube's automatic (speech recognition) captions when no human-made captions exist.", "default": true }, "translateTo": { "title": "Translate to", "type": "string", "description": "Optional. Language code, e.g. en or es, to machine-translate every transcript into with YouTube's built-in translation. Leave empty to keep the original language." }, "includeSegments": { "title": "Timestamped segments (JSON)", "type": "boolean", "description": "Array of {start, duration, end, text} segments.", "default": true }, "includeTimestampedText": { "title": "Text with timestamps", "type": "boolean", "description": "Readable text with a [hh:mm:ss] timestamp on every line. Great for LLM prompts that need citations.", "default": false }, "includeSrt": { "title": "SRT subtitles", "type": "boolean", "description": "Transcript as an .srt subtitle string.", "default": false }, "includeVtt": { "title": "WebVTT subtitles", "type": "boolean", "description": "Transcript as a .vtt subtitle string.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Videos processed in parallel (1-50, default 10).", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "YouTube blocks data-center IPs. Residential proxies (default) give reliable results.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }