{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript & Subtitles API with Timestamps", "description": "YouTube transcript API, YouTube captions API and YouTube subtitles scraper: YouTube video transcript with timestamps or plain text, as JSON or CSV. YouTube Shorts transcript, YouTube channel transcripts, YouTube playlist transcript. Any language, human or auto captions. No captions, no charge.", "version": "0.1", "x-build-id": "gmB7bWxX1FIKxnM6a" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/morgan-studio~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-morgan-studio-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/morgan-studio~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-morgan-studio-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/morgan-studio~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-morgan-studio-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": "Videos", "type": "array", "description": "One video per line: a watch URL (https://www.youtube.com/watch?v=...), a youtu.be link, a Shorts URL, an embed or live URL, or the bare 11-character video id. Duplicates are skipped. You can leave this empty and use channels or playlists instead.", "items": { "type": "string" } }, "channelUrls": { "title": "Channels", "type": "array", "description": "Channel URLs, one per line: https://www.youtube.com/@handle, /channel/UC..., /c/name or /user/name. The newest videos from the channel's Videos tab are transcribed (add /shorts or /streams to the URL for those tabs), up to Max videos per channel or playlist.", "items": { "type": "string" } }, "playlistUrls": { "title": "Playlists", "type": "array", "description": "Playlist URLs, one per line (any URL with ?list=...). Videos are transcribed in playlist order, up to Max videos per channel or playlist.", "items": { "type": "string" } }, "maxVideosPerSource": { "title": "Max videos per channel or playlist", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many videos to take from each channel or playlist (1 to 1000).", "default": 20 }, "preferredLanguages": { "title": "Preferred languages", "type": "array", "description": "Caption language codes in order of preference (en, es, de, ja, pt-BR, ...). For each language the actor takes a human-made track first, then an auto-generated one. If none of them exist, it returns the video's own track (human first) and sets matchedPreferredLanguage to false.", "default": [ "en" ], "items": { "type": "string" } }, "allowAutoGenerated": { "title": "Allow auto-generated captions", "type": "boolean", "description": "Use YouTube's automatic (speech recognition) captions when no human-made track is available. Turn off to accept human-made captions only; videos that only have automatic captions are then reported as no-captions and not charged.", "default": true }, "includeTimestamps": { "title": "Include timestamped segments", "type": "boolean", "description": "Add a segments array with start time, duration (seconds) and text for every caption line. Off: only the joined transcriptText.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many videos to fetch at the same time (1 to 10).", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Defaults to Apify Proxy's residential group, which YouTube lets through where datacenter IPs now get its sign-in bot check. The actor still moves to a fresh session whenever the check appears. Residential traffic is included in the per-transcript 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 } } } } } } } } } }