{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper: Captions, SRT & Text", "description": "Get YouTube transcripts and captions as plain text, timed segments, SRT or WebVTT, from video links, whole channels or playlists, in any language YouTube offers. Videos without captions are free.", "version": "0.1", "x-build-id": "oJS2DYn4Mfxj3FUAA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/stratumics~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-stratumics-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/stratumics~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-stratumics-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/stratumics~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-stratumics-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": { "videoUrls": { "title": "Video links", "type": "array", "description": "Videos to get transcripts for, one per line: watch, youtu.be, Shorts, live and embed links all work, and so do bare 11-character video ids.", "default": [], "items": { "type": "string" } }, "channels": { "title": "Channels", "type": "array", "description": "Channel links or handles, one per line (@mkbhd, a youtube.com/@name, /channel/UC..., /c/ or /user/ link). The newest videos of each channel get transcripts, up to the maximum below. A link to one tab, such as youtube.com/@name/shorts, reads only that tab.", "default": [], "items": { "type": "string" } }, "playlistUrls": { "title": "Playlist links", "type": "array", "description": "Playlist links (youtube.com/playlist?list=...), links to a video played from a playlist (watch?v=...&list=...), or bare playlist ids. Videos are read in the playlist's own order, up to the maximum below.", "default": [], "items": { "type": "string" } }, "maxVideos": { "title": "Maximum videos per channel or playlist", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many videos to read from each channel tab and each playlist, newest first for channels. Video links are not limited by this.", "default": 50 }, "channelTabs": { "title": "Channel tabs", "type": "array", "description": "Which tabs of each channel to read: long videos, Shorts, or past live streams. Each tab gets up to the maximum above.", "items": { "type": "string", "enum": [ "videos", "shorts", "streams" ], "enumTitles": [ "Videos", "Shorts", "Live" ] }, "default": [ "videos" ] }, "languages": { "title": "Preferred languages", "type": "array", "description": "Transcript languages in order of preference, as codes such as en, es, pt-BR or ja. The first one a video has is used; \"en\" also matches en-GB and en-US. Leave empty to get each video in its original spoken language. When a video has none of your languages, its original-language transcript is returned and the row says so.", "default": [], "items": { "type": "string" } }, "preferManualCaptions": { "title": "Prefer captions written by the creator", "type": "boolean", "description": "When a language has both creator-made captions and YouTube's automatic ones, use the creator's. Turn off to prefer the automatic ones, which follow the speech word by word.", "default": true }, "outputFormat": { "title": "Output format", "enum": [ "both", "text", "segments", "srt", "vtt" ], "type": "string", "description": "What each row carries: the plain transcript text, timed segments (start, duration, text), both, or a ready subtitle file (SRT or WebVTT, with the plain text as well).", "default": "both" }, "maxConcurrency": { "title": "Videos at once", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many videos are worked on at the same time. The default is fast and stays within YouTube's limits.", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "YouTube shows captions to Apify's servers only through a proxy, so the scraper sends those requests through Apify datacenter proxy by itself (part of every Apify plan); everything else goes out directly. Pick a proxy here only to send every request through your own.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }