{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper", "description": "Extracts full transcripts and metadata from YouTube videos. Supports single videos, channels, and playlists — returns timestamped segments, plain text, SRT, or VTT with video title, channel name, duration, and language info. No API key or proxy needed.", "version": "0.1", "x-build-id": "QeOkgQHWhSsAR2hwb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shanks0x0~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shanks0x0-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/shanks0x0~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-shanks0x0-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/shanks0x0~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-shanks0x0-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", "required": [ "source" ], "properties": { "source": { "title": "Source URL", "minLength": 2, "type": "string", "description": "YouTube video URL, channel URL, or playlist URL. Also accepts bare video IDs (11 chars) or channel IDs (UC...)." }, "sourceType": { "title": "Source Type", "enum": [ "auto", "video", "channel", "playlist" ], "type": "string", "description": "Force the interpretation of the source URL. 'auto' detects from the URL pattern.", "default": "auto" }, "maxVideos": { "title": "Max Videos", "minimum": 0, "maximum": 500, "type": "integer", "description": "Maximum number of videos to process (for channels and playlists). Set 0 for unlimited (capped at 500). Ignored for single video sources.", "default": 50 }, "languages": { "title": "Preferred Languages", "type": "array", "description": "Ordered list of language codes to try (e.g. ['en', 'en-US', 'es']). The first available track matching is used. Empty = accept any language.", "items": { "type": "string" }, "default": [] }, "translateTo": { "title": "Translate To", "type": "string", "description": "If set, fetch a translation of the transcript into this language code (e.g. 'es'). Uses YouTube's tlang parameter. Empty = no translation.", "default": "" }, "format": { "title": "Output Format", "enum": [ "segments", "plain", "srt", "vtt" ], "type": "string", "description": "How to structure the transcript text in the output.", "default": "segments" }, "includeAutoGenerated": { "title": "Include Auto-Generated", "type": "boolean", "description": "If true, include auto-generated (ASR) captions when no manual captions exist. If false, only manual/human-authored captions are returned.", "default": true }, "useProxy": { "title": "Use Proxy", "enum": [ "auto", "always", "never" ], "type": "string", "description": "Force proxy usage. 'auto' tries without proxy first, then uses Apify Proxy on failure. 'always' always uses Apify Proxy. 'never' never uses a proxy.", "default": "auto" }, "useBrowserFallback": { "title": "Browser Fallback", "type": "boolean", "description": "If true, fall back to Playwright headless browser when the HTTP API path fails for a video. If false, skip browser entirely (faster but lower success rate).", "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 } } }, "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 } } } } } } } } } }