{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper - Captions, Timestamps, Text", "description": "Transcripts of YouTube videos, Shorts, playlists and channels: full text or timestamped segments, auto-generated or manual captions, any language, plus title, channel and views. No login, no API key.", "version": "0.1", "x-build-id": "NbBJmAvTwvQEVergJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapefy~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapefy-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/scrapefy~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-scrapefy-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/scrapefy~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-scrapefy-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 transcribe, one per line. Accepts watch links (youtube.com/watch?v=...), short links (youtu.be/...), Shorts links (youtube.com/shorts/...), embed and live links, or the bare 11-character video ID. Playlist and channel links are also accepted here and expanded using the 'Max videos per playlist/channel' limit.", "items": { "type": "string" } }, "playlistOrChannelUrls": { "title": "Playlist or channel URLs (optional)", "type": "array", "description": "Optional playlist links (youtube.com/playlist?list=...) or channel links (youtube.com/@handle, /channel/UC..., /c/name). The newest videos are listed and each one is transcribed. How many is set by 'Max videos per playlist/channel'. Leave empty if you only want the videos above.", "items": { "type": "string" } }, "maxVideosPerList": { "title": "Max videos per playlist/channel", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of videos taken from each playlist or channel, newest first (channel Videos tab, playlist order). Keeps the cost of a run predictable. Does not limit the videos you list one by one.", "default": 10 }, "languages": { "title": "Preferred caption languages", "type": "array", "description": "Language codes in order of preference, for example en, de, es, pt-BR. For each language the scraper takes manual (human-made) captions first and the auto-generated track second. Matching on the base language also works (en matches en-US).", "default": [ "en" ], "items": { "type": "string" } }, "fallbackToAnyLanguage": { "title": "Fall back to any available language", "type": "boolean", "description": "When none of the preferred languages exists, return the first available track (manual first) instead of an error. The language actually returned is in the language and isAutoGenerated fields. Switch off to get an error row instead.", "default": true }, "outputFormat": { "title": "Output format", "enum": [ "both", "text", "segments" ], "type": "string", "description": "Choose what each row contains: the full transcript as one string, the list of segments with start time and duration in seconds, or both. Plain text only gives the smallest rows.", "default": "both" }, "includeMetadata": { "title": "Include video metadata", "type": "boolean", "description": "Adds title, channel name and ID, publish date, duration in seconds, view count as shown on the public page, category and the first 2,000 characters of the description. Switch off for the fastest run with only title and channel.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "YouTube blocks most datacenter IPs without a proxy, so keep Apify Proxy on (the default pool). Every attempt uses a fresh IP. The proxy cost is included in the per-transcript price.", "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 } } } } } } } } } }