{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper", "description": "Extract YouTube transcripts & captions from videos, Shorts, channels and playlists. Plain text, timestamped segments, SRT or VTT, language choice, auto-translation and video metadata. Pay only for successful transcripts; failed videos are free.", "version": "0.0", "x-build-id": "fRimAYAsScubPAdsa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/exciting_pawpaw~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-exciting_pawpaw-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/exciting_pawpaw~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-exciting_pawpaw-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/exciting_pawpaw~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-exciting_pawpaw-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": [ "startUrls" ], "properties": { "startUrls": { "title": "YouTube URLs or video IDs", "type": "array", "description": "Video URLs (watch, youtu.be, shorts, live, embed), bare 11-character video IDs, channel URLs (@handle, /channel/UC..., /c/..., /user/...; add /videos, /shorts or /streams to pick a tab) or playlist URLs. Channels and playlists are expanded to their videos (newest first for channels).", "items": { "type": "string" } }, "languages": { "title": "Preferred transcript languages", "type": "array", "description": "Language codes in order of preference, e.g. [\"en\", \"de\"]. \"en\" also matches regional variants such as en-US/en-GB. Leave empty to get the transcript in the video's original language.", "default": [], "items": { "type": "string" } }, "fallbackToAnyLanguage": { "title": "Fall back to original language", "type": "boolean", "description": "If none of the preferred languages is available, return the transcript in the video's original language instead of an error record.", "default": true }, "translateTo": { "title": "Auto-translate to language", "type": "string", "description": "Optional language code (e.g. \"en\", \"es\", \"ja\"). If the video has no native transcript in that language, YouTube's machine translation of the selected transcript is returned.", "default": "" }, "preferManualCaptions": { "title": "Prefer human-made captions", "type": "boolean", "description": "When both uploader-provided and auto-generated captions exist in the chosen language, use the uploader-provided ones.", "default": true }, "outputFormats": { "title": "Transcript formats", "type": "array", "description": "Which transcript representations to include in each result: plain text, timestamped segments, SRT and/or WebVTT subtitles.", "items": { "type": "string", "enum": [ "text", "segments", "srt", "vtt" ], "enumTitles": [ "Plain text", "Timestamped segments", "SRT subtitles", "WebVTT subtitles" ] }, "default": [ "text", "segments" ] }, "maxVideosPerSource": { "title": "Max videos per channel/playlist", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many of the newest videos to take from each channel or playlist URL.", "default": 20 }, "maxItems": { "title": "Max videos in total", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Upper limit on the number of videos processed in this run.", "default": 100 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many videos to process in parallel.", "default": 8 } } }, "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 } } } } } } } } } }