{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper — Fast, Reliable, Pay Per Result", "description": "Extract YouTube transcripts (timestamped segments, plain text, SRT, VTT) from videos, channels, playlists, and search. Honest per-video statuses; you only pay for delivered transcripts.", "version": "0.1", "x-build-id": "DvMxFyMbI6AUdqtMr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetchworks~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetchworks-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/fetchworks~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-fetchworks-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/fetchworks~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-fetchworks-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 video URLs (watch, youtu.be, Shorts, embed, live) or bare 11-character video IDs. One transcript is extracted per video.", "items": { "type": "string" } }, "channelUrls": { "title": "Channel URLs or @handles", "type": "array", "description": "Channel URLs (youtube.com/@handle, /channel/UC…, /c/…, /user/…) or bare @handles. All uploads are enumerated newest first, bounded by 'Max videos per channel'.", "items": { "type": "string" } }, "maxVideosPerChannel": { "title": "Max videos per channel", "minimum": 1, "type": "integer", "description": "Upper bound on videos taken from each channel (newest first). No hard cap.", "default": 100 }, "playlistUrls": { "title": "Playlist URLs or IDs", "type": "array", "description": "Playlist URLs (youtube.com/playlist?list=…) or bare playlist IDs (PL…, UU…).", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "YouTube search queries; top video results are transcribed, bounded by 'Max search results'.", "items": { "type": "string" } }, "maxSearchResults": { "title": "Max search results", "minimum": 1, "type": "integer", "description": "Upper bound on videos taken per search query.", "default": 50 }, "languages": { "title": "Preferred languages", "type": "array", "description": "Language priority list (ISO codes, e.g. [\"en\", \"de\"]). The first available matching caption track wins. If none match, the video's default track is used and the actual language is reported on the item.", "default": [ "en" ], "items": { "type": "string" } }, "preferAutoGenerated": { "title": "Prefer auto-generated captions", "type": "boolean", "description": "When a language has both a manual and an auto-generated (ASR) track, prefer the auto-generated one. Default prefers manual captions.", "default": false }, "translateTo": { "title": "Translate to", "type": "string", "description": "Optional target language code (e.g. \"es\"). Uses YouTube's caption auto-translation. Best-effort: YouTube throttles translated tracks globally; failures are reported as translation_unavailable and never billed." }, "outputFormats": { "title": "Output formats", "type": "array", "description": "Transcript representations to include on each item.", "items": { "type": "string", "enum": [ "segments", "text", "srt", "vtt" ], "enumTitles": [ "Timestamped segments", "Plain text", "SRT subtitles", "WebVTT subtitles" ] }, "default": [ "segments", "text" ] }, "includeMetadata": { "title": "Include video metadata", "type": "boolean", "description": "Include title, channel, duration, views, publish date, thumbnails, etc. Comes free with extraction.", "default": true }, "includeChapters": { "title": "Include chapters", "type": "boolean", "description": "Include video chapters. Costs one extra request per video.", "default": false }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many videos are processed in parallel.", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy used for YouTube API calls. Residential proxy is strongly recommended — datacenter IPs are bot-checked by YouTube on most videos.", "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 } } }, "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 } } } } } } } } } }