{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper - Channels, Playlists, SRT", "description": "Get YouTube transcripts and subtitles in bulk: paste video, channel or playlist URLs or search terms. Returns clean text, timestamped segments, SRT or VTT plus video metadata. Picks your preferred language, manual captions first. Pay only for transcripts found.", "version": "1.0", "x-build-id": "Wfd28G8Nud36Pnbed" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datafetch_labs~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datafetch_labs-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/datafetch_labs~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-datafetch_labs-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/datafetch_labs~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-datafetch_labs-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 URLs", "type": "array", "description": "Video URLs or IDs, Shorts, channel URLs or @handles (all their videos), and playlist URLs. One per line.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Search YouTube and get transcripts of the top results, e.g. \"sourdough recipe\".", "items": { "type": "string" } }, "maxVideosPerSource": { "title": "Max videos per channel / playlist / search", "minimum": 0, "type": "integer", "description": "0 = all videos (playlists: up to 200).", "default": 50 }, "channelTab": { "title": "Channel content", "enum": [ "videos", "shorts", "streams" ], "type": "string", "description": "Which tab of a channel to take videos from.", "default": "videos" }, "languages": { "title": "Preferred languages", "type": "array", "description": "Language codes in order of preference (e.g. en, es, de, pt). The first available is used.", "default": [ "en" ], "items": { "type": "string" } }, "fallbackToAnyLanguage": { "title": "Fall back to any language", "type": "boolean", "description": "If none of the preferred languages exist, return the video's own captions in whatever language they are.", "default": true }, "preferManualCaptions": { "title": "Prefer human-made captions", "type": "boolean", "description": "Use uploader-made captions over YouTube's auto-generated ones when both exist.", "default": true }, "outputFormats": { "title": "Output formats", "type": "array", "description": "Transcript formats to include in each result.", "items": { "type": "string", "enum": [ "text", "timestampedText", "segments", "srt", "vtt" ], "enumTitles": [ "Plain text (paragraphs)", "Text with [hh:mm:ss] timestamps", "Segments (JSON with start/duration)", "SRT subtitles", "WebVTT subtitles" ] }, "default": [ "text", "segments" ] }, "includeVideosWithoutTranscript": { "title": "Include videos without transcript", "type": "boolean", "description": "Add a (free) row with the reason for videos that have no captions.", "default": true }, "maxConcurrency": { "title": "Parallel videos", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel videos.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Used only if YouTube starts blocking direct requests. Residential proxy is recommended.", "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 } } } } } } } } } }