{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper", "description": "Extract YouTube transcripts from videos, playlists, and channel videos. Verify caption language and export subtitle timings with millisecond precision.", "version": "0.0", "x-build-id": "uTETDRdVu5dfFi24b" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hypebridge~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hypebridge-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/hypebridge~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-hypebridge-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/hypebridge~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-hypebridge-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": "YouTube video, playlist, or channel URLs", "maxItems": 10000, "type": "array", "description": "Video URLs or 11-character IDs, playlist URLs, and channel URLs. Up to 10,000 entries; playlists and channel Videos tabs expand up to maxItems.", "items": { "type": "string", "maxLength": 2048 }, "default": [] }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum videos processed in this run.", "default": 100 }, "captionLanguage": { "title": "Caption language", "pattern": "^(?:auto|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*)$", "minLength": 2, "maxLength": 16, "type": "string", "description": "Select a verified YouTube caption track by BCP-47 code (for example en or es-ES). The Actor prefers manual captions over auto-generated captions in that language, returns the actual track language and name, and returns language_unavailable if none matches. Auto keeps the existing transcript behavior.", "default": "auto" }, "preferredLanguage": { "title": "Legacy locale hint", "enum": [ "auto", "en", "hi", "pt-BR", "ja", "de", "es", "fr" ], "type": "string", "description": "Compatibility input for older integrations. This only hints the UI locale and does not verify or select a caption language.", "default": "auto" }, "proxyCountry": { "title": "Market", "enum": [ "AUTO", "US", "IN", "BR", "JP", "DE" ], "type": "string", "description": "Override the country context for all videos. Automatic uses URL market hints.", "default": "AUTO" }, "includeFullText": { "title": "Include full text", "type": "boolean", "description": "Include the transcript joined into one string.", "default": true }, "includeSegments": { "title": "Include segments", "type": "boolean", "description": "Include timestamped segments.", "default": true }, "includeSubtitles": { "title": "Include SRT and WebVTT", "type": "boolean", "description": "Include SRT and WebVTT. Explicit captionLanguage uses YouTube source cue timings in milliseconds; automatic mode uses inferred end times.", "default": false }, "includeChapters": { "title": "Include chapters", "type": "boolean", "description": "Include chapter titles. In exact-language mode this makes an extra YouTube request; automatic mode already gets chapters with the transcript.", "default": true }, "diagnosticFallback": { "title": "Diagnose empty transcripts", "type": "boolean", "description": "Fetch a watch page once to classify an empty response.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "Concurrent videos, from 1 to 15.", "default": 15 } } }, "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 } } } } } } } } } }