{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper", "description": "Extract YouTube transcripts and captions from videos, playlists or whole channels. Get full transcript text, timestamped segments, language and auto-generated flag, plus title, channel, views and duration. Any language, bulk, no API key.", "version": "0.1", "x-build-id": "U4kfSJt16SPFOHTGg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cirkit~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cirkit-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/cirkit~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-cirkit-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/cirkit~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-cirkit-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 URLs or IDs", "type": "array", "description": "YouTube videos to get transcripts for. Accepts watch URLs, youtu.be links, Shorts URLs, embed and live URLs, or bare 11-character video IDs. One row per video.", "items": { "type": "string" } }, "playlistUrls": { "title": "Playlist URLs", "type": "array", "description": "YouTube playlists to transcribe, as https://www.youtube.com/playlist?list=... links (or any URL with a list= parameter) or bare playlist IDs. Videos are taken in playlist order, up to the per-source limit.", "items": { "type": "string" } }, "channels": { "title": "Channels", "type": "array", "description": "YouTube channels to transcribe, newest uploads first. Accepts a handle (@3blue1brown), a channel URL, or a channel ID (UC...). Up to the per-source limit of videos per channel.", "items": { "type": "string" } }, "language": { "title": "Transcript language", "type": "string", "description": "Language code of the transcript you want, for example en, es, de, pt-BR or ja. A regional code also matches its base language (en matches en-US and en-GB). If the video has no transcript in this language, see the fallback option below.", "default": "en" }, "fallbackToAnyLanguage": { "title": "Fall back to the original language", "type": "boolean", "description": "When the requested language is not available, return the video's own transcript instead (usually its auto-generated track, which is in the spoken language) and flag it with isFallbackLanguage. Turn off to get a language_unavailable row with the list of available languages instead.", "default": true }, "preferManualCaptions": { "title": "Prefer creator-uploaded captions", "type": "boolean", "description": "When both creator-uploaded and auto-generated captions exist in the chosen language, return the creator-uploaded ones (better punctuation and accuracy). Turn off to prefer the auto-generated track.", "default": true }, "includeTimestamps": { "title": "Include timestamped segments", "type": "boolean", "description": "Add the segments array: every caption line with its start time, end time and duration in seconds. Turn off if you only need the plain transcript text, which keeps the output smaller.", "default": true }, "maxVideosPerSource": { "title": "Max videos per playlist or channel", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Upper limit of videos taken from each playlist and each channel. Video URLs you list directly are not affected.", "default": 50 }, "maxItems": { "title": "Max transcripts in total", "minimum": 0, "type": "integer", "description": "Hard cap on the number of rows written to the dataset across all inputs. You are charged per row, so this is your spend limit. Leave empty for no total cap." }, "residentialFallback": { "title": "Retry blocked videos on residential proxy", "type": "boolean", "description": "When YouTube refuses a video three times on the proxy above, retry it on Apify RESIDENTIAL proxy (US). This keeps the success rate near 100% at no extra cost to you. Only turn it off if your account cannot use residential proxy.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is used by default. YouTube occasionally asks datacenter IPs to sign in, so videos that keep hitting that wall are retried automatically on Apify RESIDENTIAL proxy (see the option below). You rarely need to change this.", "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 } } } } } } } } } }