{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper: Captions, Subtitles & Text", "description": "Get YouTube transcripts from videos, Shorts, channels, playlists and searches: full text, timestamped segments, SRT/VTT, title, channel, duration and publish date. Videos without captions are transcribed by Whisper. Failed videos are free.", "version": "1.0", "x-build-id": "abGmCqLFnpx5ezOzQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/northloop-labs~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-northloop-labs-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/northloop-labs~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-northloop-labs-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/northloop-labs~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-northloop-labs-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": { "urls": { "title": "YouTube URLs", "type": "array", "description": "Video, Shorts, channel (@handle, /channel/…) or playlist URLs, or plain 11-character video IDs. Channels list their newest videos first (add /shorts or /streams to the channel URL for those tabs).", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search on YouTube. The top results (up to Max videos per source) are transcribed.", "items": { "type": "string" } }, "maxVideos": { "title": "Max videos per source", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum videos taken from each channel, playlist or search term. Single video URLs always count as one.", "default": 10 }, "searchSort": { "title": "Search sort order", "enum": [ "relevance", "date" ], "type": "string", "description": "Order of search results: relevance (YouTube's default) or newest uploads first.", "default": "relevance" }, "language": { "title": "Transcript language", "type": "string", "description": "Language code for the captions, e.g. en, es, de, pt-BR. Leave empty for the video's original language. If that language has no captions, YouTube's auto-translation is tried, then the original language is returned (see the note field).", "default": "" }, "transcriptSource": { "title": "Transcript source", "enum": [ "captions-then-whisper", "captions-only", "whisper-only" ], "type": "string", "description": "captions-then-whisper: use YouTube captions and transcribe the audio with Whisper only when a video has no captions. captions-only: never use Whisper (cheapest). whisper-only: always transcribe the audio, even when captions exist.", "default": "captions-then-whisper" }, "preferManualCaptions": { "title": "Prefer human-made captions", "type": "boolean", "description": "Use uploader-made captions before YouTube's auto-generated ones when both exist.", "default": true }, "maxWhisperMinutesPerVideo": { "title": "Max Whisper minutes per video", "minimum": 0, "type": "integer", "description": "Videos longer than this are skipped (free row) instead of transcribed with Whisper. 0 = no limit.", "default": 60 }, "maxTotalWhisperMinutes": { "title": "Max Whisper minutes per run", "minimum": 0, "type": "integer", "description": "Stop using Whisper after this many audio minutes in one run. 0 = no limit (the run's maximum cost still applies).", "default": 0 }, "whisperLanguage": { "title": "Whisper spoken language", "type": "string", "description": "Optional language code of the speech for Whisper (e.g. en, es). Leave empty to auto-detect. Whisper writes the spoken language; it does not translate.", "default": "" }, "includeSegments": { "title": "Include timestamped segments", "type": "boolean", "description": "Add a segments array: [{start, end, text}] in seconds.", "default": true }, "includeSrt": { "title": "Include SRT subtitles", "type": "boolean", "description": "Add the transcript as an SRT subtitle string.", "default": false }, "includeVtt": { "title": "Include WebVTT subtitles", "type": "boolean", "description": "Add the transcript as a WebVTT subtitle string.", "default": false } } }, "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 } } } } } } } } } }