{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper: Captions, Timestamps & Metadata", "description": "Get YouTube video transcripts (manual or auto-generated captions) as timestamped segments and clean plain text, with title, channel, duration, views and publish date. Paste video, channel or playlist URLs. No browser, no API key. Videos without captions are free.", "version": "0.1", "x-build-id": "vlzsi6aWwhs20bEzk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/changefeeds~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-changefeeds-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/changefeeds~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-changefeeds-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/changefeeds~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-changefeeds-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", "required": [ "videos" ], "properties": { "videos": { "title": "Videos", "type": "array", "description": "YouTube videos to get transcripts for: watch URLs, youtu.be links, /shorts/, /live/ and /embed/ URLs, or bare 11-character video ids. A channel URL (https://www.youtube.com/@name) or playlist URL (https://www.youtube.com/playlist?list=...) adds that channel's latest uploads or the playlist's first videos (see Max videos per channel or playlist). Invalid entries come back as a free status row; the run continues.", "items": { "type": "string" } }, "language": { "title": "Preferred language", "type": "string", "description": "Caption language code, e.g. en, es, de, pt-BR, ja. Picks a manual track in this language first, then an auto-generated one; if the video has neither, the first available track is returned and the row says so (requested_language_matched: false). Translation is not performed.", "default": "en" }, "outputFormat": { "title": "Output format", "enum": [ "both", "segments", "text" ], "type": "string", "description": "segments: timestamped caption lines ({start, duration, text}); text: one plain transcript string; both: both fields.", "default": "both" }, "includeTimestampsInText": { "title": "Timestamps in plain text", "type": "boolean", "description": "Write the plain text as one \"[hh:mm:ss] line\" per caption instead of a single paragraph.", "default": false }, "includeDescription": { "title": "Include video description", "type": "boolean", "description": "Add the video's description to each transcript row.", "default": false }, "maxVideos": { "title": "Max videos", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Upper limit on videos processed in one run (after channels and playlists are expanded and duplicates removed).", "default": 1000 }, "maxVideosPerChannel": { "title": "Max videos per channel or playlist", "minimum": 1, "maximum": 30, "type": "integer", "description": "For channel URLs: how many of the latest uploads to take. For playlist URLs: how many videos from the start. At most 30 (the first page YouTube lists).", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "YouTube blocks most requests from cloud-server IPs with a bot check, so requests go through Apify residential proxy by default, and blocked videos are retried through fresh proxy IPs. Proxy traffic is included in the price. Turn it off only when running from your own network.", "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 } } } } } } } } } }