{ "openapi": "3.0.1", "info": { "title": "Youtube Video Transcript Scraper", "description": "Extract transcripts and metadata from YouTube videos, channels, and search results at lightning speed. Powered by the industry-standard yt-dlp engine, this actor is designed to be lightweight, efficient, and cost-effective.", "version": "0.0", "x-build-id": "oUdZdqsYgyhWuJ06w" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/leandrocb88~youtube-video-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-leandrocb88-youtube-video-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/leandrocb88~youtube-video-transcript-scraper/runs": { "post": { "operationId": "runs-sync-leandrocb88-youtube-video-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/leandrocb88~youtube-video-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-leandrocb88-youtube-video-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": [ "maxConcurrency" ], "properties": { "startUrls": { "title": "Video URLs", "type": "array", "description": "List of direct YouTube video URLs.", "items": { "type": "string" } }, "searchKeywords": { "title": "Search Terms", "type": "array", "description": "List of keywords to search for.", "items": { "type": "string" } }, "maxVideosPerSearch": { "title": "Max Videos per Search", "type": "integer", "description": "Maximum regular videos to scrape per search result.", "default": 10 }, "maxShortsPerSearch": { "title": "Max Shorts per Search", "type": "integer", "description": "Maximum Shorts to scrape per search result (0 = exclude).", "default": 10 }, "maxStreamsPerSearch": { "title": "Max Streams per Search", "type": "integer", "description": "Maximum Live Streams to scrape per search result (0 = exclude).", "default": 10 }, "searchDateFilter": { "title": "Search Date Filter", "enum": [ "all", "hour", "today", "week", "month", "year" ], "type": "string", "description": "Filter search results by upload date.", "default": "all" }, "searchSortBy": { "title": "Search Sort By", "enum": [ "relevance", "date", "viewCount", "rating" ], "type": "string", "description": "Sort order for search results.", "default": "relevance" }, "channelUrls": { "title": "Channel URLs", "type": "array", "description": "List of Channel URLs (e.g., https://www.youtube.com/@ChannelName/videos).", "items": { "type": "string" } }, "maxVideosPerChannel": { "title": "Max Videos per Channel", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum regular videos to scrape per channel (0 = exclude videos).", "default": 10 }, "maxShortsPerChannel": { "title": "Max Shorts per Channel", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum Shorts to scrape per channel (0 = exclude shorts).", "default": 10 }, "maxStreamsPerChannel": { "title": "Max Live Streams per Channel", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum Live Streams to scrape per channel (0 = exclude streams).", "default": 10 }, "channelSortBy": { "title": "Channel Sort By", "enum": [ "latest", "popular", "oldest" ], "type": "string", "description": "Sort order when retrieving videos from a channel.", "default": "latest" }, "channelDateFilterMode": { "title": "Date Filter Mode", "enum": [ "none", "relative", "absolute" ], "type": "string", "description": "Custom strategy to stop scraping older channel videos.", "default": "none" }, "channelDaysBack": { "title": "Days Back (Relative)", "minimum": 1, "type": "integer", "description": "Stop scraping when videos are older than X days. Requires Date Filter Mode: relative.", "default": 7 }, "channelMinDate": { "title": "Scrape after date (Absolute)", "pattern": "^(\\d{8})?$", "type": "string", "description": "Stop scraping videos older than this. Format: YYYYMMDD. Requires Date Filter Mode: absolute." }, "downloadSubtitles": { "title": "Download Subtitles", "type": "boolean", "description": "If disabled, only metadata (views, date, title) will be scraped.", "default": true }, "subtitleLanguage": { "title": "Subtitle Language", "type": "string", "description": "Preferred language code (e.g., 'en', 'es', 'fr').", "default": "en" }, "preferAutoSubtitles": { "title": "Prefer Auto-Generated", "type": "boolean", "description": "If true, prefers auto-generated captions over manual ones.", "default": false }, "includeTimestamps": { "title": "Include Timestamps", "type": "boolean", "description": "If true, output includes start/end times. If false, output is plain text.", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 5, "maximum": 20, "type": "integer", "description": "Maximum number of parallel requests (default 5, min 5, max 20).", "default": 10 } } }, "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 } } } } } } } } } }