{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper API: Subtitles & Captions", "description": "YouTube transcript API: bulk transcripts, subtitles and captions from videos, Shorts, playlists, channels and searches. Any language, auto-translate, timestamps, text/SRT/VTT. $2.50 per 1,000.", "version": "1.0", "x-build-id": "OXdC1oW5U9lLbPxOS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/best_apis~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-best_apis-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/best_apis~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-best_apis-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/best_apis~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-best_apis-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": { "videos": { "title": "Videos, Shorts, channels, playlists or search terms", "type": "array", "description": "One per line. Accepts any YouTube link (watch, youtu.be, Shorts, embed, live), bare 11-character video IDs, channel URLs or @handles (latest uploads), playlist URLs or IDs, and plain search keywords.", "items": { "type": "string" } }, "languages": { "title": "Preferred caption languages (in order)", "type": "array", "description": "Language codes in order of preference, e.g. en, es, pt-BR. Use \"auto\" to get the video's original spoken language. The first available match wins; manually written captions are preferred over auto-generated ones in the same language.", "default": [ "en", "auto" ], "items": { "type": "string" } }, "translateTo": { "title": "Translate to language (optional)", "type": "string", "description": "Language code (e.g. en, es, de, ja). If the picked captions are in another language, YouTube's own auto-translation is returned. Also used as a fallback when none of your preferred languages exist." }, "outputFormats": { "title": "Output formats", "type": "array", "description": "Which transcript formats to include in each result.", "items": { "type": "string", "enum": [ "segments", "text", "srt", "vtt" ], "enumTitles": [ "Timestamped segments (JSON)", "Plain text", "SRT subtitles", "WebVTT subtitles" ] }, "default": [ "segments", "text" ] }, "maxVideosPerSource": { "title": "Max videos per channel / playlist / search", "minimum": 1, "maximum": 20000, "type": "integer", "description": "How many videos to take from each channel, playlist or search (newest first for channels).", "default": 50 }, "includeMetadata": { "title": "Include video metadata", "type": "boolean", "description": "Title, channel, duration, views, description, keywords, thumbnail.", "default": true }, "preferManualCaptions": { "title": "Prefer human-made captions", "type": "boolean", "description": "When both exist in a language, use manually created captions over auto-generated ones.", "default": true }, "onlyNewVideos": { "title": "Only new videos since last run", "type": "boolean", "description": "Skip videos already transcribed in previous runs with the same state key. Great for scheduled channel monitoring.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Name for the 'already seen' memory used by 'Only new videos'. Use different keys for different feeds.", "default": "default" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 100, "type": "integer", "description": "Parallel videos.", "default": 20 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Defaults to Apify RESIDENTIAL proxy, which YouTube needs from cloud IPs. Residential traffic is billed to your own Apify plan (about 40 KB per video). Free Apify plans have no residential access, so expect blocks there. Set \"No proxy\" to try direct and datacenter IPs only.", "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 } } } } } } } } } }