{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper - Bulk Channels, Playlists, Search", "description": "Transcripts for YouTube videos, Shorts, whole channels, playlists and search results in one run: transcript text, timestamped segments, optional SRT and WebVTT, plus title, channel, views, duration, publish date and keywords. You pay only for transcripts delivered.", "version": "1.0", "x-build-id": "Wh6ITWaGaUHbWcaoY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mochiboo~youtube-transcript-bulk-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mochiboo-youtube-transcript-bulk-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/mochiboo~youtube-transcript-bulk-scraper/runs": { "post": { "operationId": "runs-sync-mochiboo-youtube-transcript-bulk-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/mochiboo~youtube-transcript-bulk-scraper/run-sync": { "post": { "operationId": "run-sync-mochiboo-youtube-transcript-bulk-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": { "startUrls": { "title": "YouTube URLs or video IDs", "type": "array", "description": "Video, Shorts, youtu.be, channel (@handle, /channel/UC..., /c/, /user/) or playlist URLs. Bare 11-character video IDs work too.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Transcribe the top videos of a YouTube search.", "default": [], "items": { "type": "string" } }, "maxVideosPerSource": { "title": "Max videos per channel, playlist or search", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Single video URLs are always processed. Hard cap 5000.", "default": 20 }, "languages": { "title": "Preferred caption languages", "type": "array", "description": "Language codes in order of preference, e.g. en, es, de. 'en' also matches en-GB. Falls back to the video's default caption track.", "default": [ "en" ], "items": { "type": "string" } }, "preferManualCaptions": { "title": "Prefer human-made captions over auto-generated", "type": "boolean", "description": "Use a human-made caption track when the video has one in a matching language, and fall back to auto-generated captions. Turn off to prefer auto-generated captions.", "default": true }, "includeSegments": { "title": "Include timestamped segments", "type": "boolean", "description": "Add a segments array of {start, duration, text} objects (seconds) to every row.", "default": true }, "includeSrt": { "title": "Include SRT subtitle text", "type": "boolean", "description": "Add an srt field with the transcript as SubRip subtitles.", "default": false }, "includeVtt": { "title": "Include WebVTT subtitle text", "type": "boolean", "description": "Add a vtt field with the transcript as WebVTT subtitles.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify residential proxy is on by default (each video gets its own IP). YouTube asks most datacenter IPs to sign in, so datacenter proxies are not recommended. You can pick another group or your own proxy URLs.", "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 } } } } } } } } } }