{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper — Videos, Channels & Playlists", "description": "YouTube transcript scraper and API: captions with timestamps, plain text or SRT, title, channel, views and duration for videos, whole channels and playlists. No login.", "version": "0.2", "x-build-id": "czGhYiBlIxGvUM9Q2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/innolabs~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-innolabs-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/innolabs~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-innolabs-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/innolabs~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-innolabs-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": { "videoUrls": { "title": "Video URLs", "type": "array", "description": "YouTube video links: watch, youtu.be, Shorts, embed or live URLs. Channel and playlist links go in the fields below.", "items": { "type": "string" } }, "channelUrls": { "title": "Channel URLs", "type": "array", "description": "Channel links such as https://www.youtube.com/@mkbhd, /channel/UC…, /c/… or /user/…, a bare @handle or a UC… channel ID. Add /shorts or /streams to the link to read that tab; otherwise Channel tab below is used. Newest videos first, up to Max videos per channel.", "items": { "type": "string" } }, "playlistUrls": { "title": "Playlist URLs", "type": "array", "description": "Playlist links (any YouTube link with a list= parameter) or bare playlist IDs such as PL…. Videos are taken in playlist order, up to Max videos per playlist.", "items": { "type": "string" } }, "videoIds": { "title": "Video IDs", "type": "array", "description": "Bare 11-character YouTube video IDs, e.g. dQw4w9WgXcQ.", "items": { "type": "string" } }, "languages": { "title": "Languages", "type": "array", "description": "Language codes in priority order. Use YouTube codes such as en, de-DE, pt-BR, es-419. One item is returned per video and language actually found; auto-generated captions count.", "items": { "type": "string" }, "default": [ "en" ] }, "format": { "title": "Transcript format", "enum": [ "json", "text", "srt" ], "type": "string", "description": "How transcriptText is rendered. Timestamped segments are included separately when Include segments is on.", "default": "json" }, "includeSegments": { "title": "Include segments", "type": "boolean", "description": "Add timestamped caption segments (start, duration, text) to each item.", "default": true }, "includeMetadata": { "title": "Include metadata", "type": "boolean", "description": "Add title, channel, duration, view count and publish date. If metadata cannot be read, the transcript is still returned.", "default": true }, "channelVideoType": { "title": "Channel tab", "enum": [ "videos", "shorts", "streams" ], "type": "string", "description": "Which channel tab to read for Channel URLs that do not name one: long-form Videos, Shorts or past live Streams.", "default": "videos" }, "maxVideosPerChannel": { "title": "Max videos per channel", "minimum": 1, "type": "integer", "description": "Newest videos taken from each channel.", "default": 50 }, "maxVideosPerPlaylist": { "title": "Max videos per playlist", "minimum": 1, "type": "integer", "description": "Videos taken from each playlist, from the top.", "default": 50 }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Hard cap on results (one result per video and language). The run stops cleanly when reached and you are never charged above it.", "default": 1000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy for all YouTube requests. Residential is the default because YouTube blocks Apify datacenter IPs for transcripts. Each video uses about 20–30 KB of proxy traffic.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Log metadata lookup failures and other diagnostics.", "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 } } } } } } } } } }