{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper", "description": "Get transcripts from YouTube videos, Shorts, live streams, channels, playlists and search results as text, timestamped segments, SRT or WebVTT. No login or API key. You are charged only for rows that return a transcript.", "version": "0.1", "x-build-id": "4Dy3Xh1lZvClrwLPb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rastriq~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rastriq-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/rastriq~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-rastriq-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/rastriq~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-rastriq-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 or live URLs, video IDs, channel URLs (@handle, /channel/UC..., add /shorts or /streams to pick a tab) and playlist URLs. Mix them freely.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Optional. Transcribe the top videos for each YouTube search query.", "items": { "type": "string" } }, "maxVideosPerSource": { "title": "Max videos per channel / playlist / search", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Direct video URLs are not limited by this.", "default": 20 }, "maxVideos": { "title": "Max videos in total", "minimum": 0, "type": "integer", "description": "Hard cap for the whole run. 0 = no cap.", "default": 0 }, "channelTabs": { "title": "Channel tabs", "type": "array", "description": "Which tabs to read when a channel URL has no tab in it.", "items": { "type": "string", "enum": [ "videos", "shorts", "streams" ], "enumTitles": [ "Videos", "Shorts", "Live streams" ] }, "default": [ "videos" ] }, "publishedAfter": { "title": "Published after", "type": "string", "description": "YYYY-MM-DD or relative, e.g. '30 days'. Applies to channels, playlists and searches. Channels stop paging once older videos are reached." }, "publishedBefore": { "title": "Published before", "type": "string", "description": "YYYY-MM-DD or relative, e.g. '7 days'." }, "languages": { "title": "Preferred languages", "type": "array", "description": "Language codes in order of preference (e.g. es, en). The first one available wins. Leave empty for the video's default captions.", "items": { "type": "string" } }, "fallbackToAnyLanguage": { "title": "Fall back to any language", "type": "boolean", "description": "If none of the preferred languages exists, return the default track instead of a LANGUAGE_NOT_AVAILABLE row.", "default": true }, "preferAutoGenerated": { "title": "Prefer auto-generated captions", "type": "boolean", "description": "By default creator-uploaded captions win over auto-generated ones.", "default": false }, "outputFormats": { "title": "Output formats", "type": "array", "description": "Fields added to each transcript row. Plain text and segments are on by default; timestamped text is handy for LLM prompts; SRT/WebVTT are ready-to-use subtitle files.", "items": { "type": "string", "enum": [ "text", "segments", "timestamped", "srt", "vtt" ], "enumTitles": [ "Plain text", "Segments with timestamps (JSON)", "Timestamped text [hh:mm:ss] (LLM-friendly)", "SRT subtitles", "WebVTT subtitles" ] }, "default": [ "text", "segments" ] }, "includeMetadata": { "title": "Include video metadata", "type": "boolean", "description": "Publish date, likes, description, keywords and thumbnail. Title, channel, duration and views are always included.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Videos processed in parallel. 5 is a good default.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "YouTube blocks transcript requests from datacenter IPs. Residential proxy is required and its cost is included in the price.", "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 } } } } } } } } } }