{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper", "description": "Get YouTube video transcripts and captions (manual or auto-generated) with timestamps, plain text and video title/channel. Fast, reliable, pay only for transcripts delivered.", "version": "0.2", "x-build-id": "5Zh01rOs9UdMLco7A" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/potato_44~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-potato_44-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/potato_44~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-potato_44-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/potato_44~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-potato_44-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, playlists or channels", "type": "array", "description": "YouTube video URLs or IDs (watch, youtu.be, Shorts, live, embed), playlist URLs, or channel URLs (@handle, /channel/…, add /shorts or /streams for those tabs). A watch URL that also has &list= is treated as that single video.", "items": { "type": "string" } }, "searchQueries": { "title": "YouTube search queries", "type": "array", "description": "Get transcripts for the top search results of each query (up to 'Max videos per playlist/channel/search').", "items": { "type": "string" } }, "maxVideosPerSource": { "title": "Max videos per playlist/channel/search", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Limit for each playlist, channel or search query. Single video URLs are always included.", "default": 20 }, "outputFormat": { "title": "Output format", "enum": [ "both", "segments", "text", "srt", "vtt" ], "type": "string", "description": "Timestamped segments, a single plain-text string, or subtitle files (SRT / WebVTT).", "default": "both" }, "includeDetails": { "title": "Include description, tags & chapters", "type": "boolean", "description": "Adds the video description, keywords/tags and chapters to each result. Views, upload date, duration and category are always included.", "default": false }, "languages": { "title": "Preferred languages", "type": "array", "description": "Preferred language codes, e.g. [\"en\"] or [\"es\"]. You get the video's transcript in your first preferred language when the video has it, otherwise its default language (if 'Fall back to any available language' is on). Leave empty for each video's own default.", "default": [ "en" ], "items": { "type": "string" } }, "anyLanguage": { "title": "Fall back to any available language", "type": "boolean", "description": "If the video has no transcript in your preferred languages, return its default transcript instead of an error. Turn off to get only your exact languages (slower, exact track check).", "default": true }, "preferManual": { "title": "Prefer human-made captions", "type": "boolean", "description": "When an exact track check is needed (fallback off), prefer creator-made captions over auto-generated ones.", "default": true } } }, "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 } } } } } } } } } }