{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper", "description": "Export public YouTube captions as transcript text and timestamped segments. Use video URLs or IDs, select a language, and download JSON or CSV for research and RAG.", "version": "0.1", "x-build-id": "9t9t1ghk9J48FoJpU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetch_cat~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetch_cat-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/fetch_cat~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-fetch_cat-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/fetch_cat~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-fetch_cat-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 URLs", "type": "array", "description": "Public YouTube watch, Shorts, live, embed or youtu.be URLs. Use this list or Video IDs. Unsupported hosts, malformed IDs and credential-bearing URLs are skipped with input warnings while valid targets are retained. If no usable targets remain, the run finishes with a warning and no extraction or start charge.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "videoIds": { "title": "Video IDs", "type": "array", "description": "Optional raw 11-character YouTube video IDs. Use this instead of URLs if you already have IDs.", "default": [], "items": { "type": "string" } }, "language": { "title": "Preferred caption language", "type": "string", "description": "Preferred caption language code, such as en, es, de, or fr. When supported, YouTube-provided translation may be requested. Another available track can be used if the preferred track fails. Check the returned language.", "default": "en" }, "includeTimestamps": { "title": "Include timestamps", "type": "boolean", "description": "Include start and duration values for every transcript segment.", "default": true }, "includeMetadata": { "title": "Include video metadata", "type": "boolean", "description": "Include title, channel name, duration, and thumbnail URL when YouTube exposes them publicly.", "default": true }, "maxVideos": { "title": "Maximum videos", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum unique valid videos selected, from 1 to 500. The default is 5. Processing is also bounded by the original five-minute run budget, response/output size safeguards and remaining transcript-charge capacity. Restarts do not renew the time budget. Check the run summary for targets not processed or saved.", "default": 5 }, "connectionMode": { "title": "Connection", "enum": [ "direct", "automatic" ], "type": "string", "description": "Automatic preserves the existing strategy: direct requests first, with Apify Residential Proxy fallback only after an eligible blocking response. Proxy usage can add cost and does not guarantee captions. Direct never enables a proxy fallback. Explicit legacy proxyConfiguration settings take precedence over this selector, including its default and prefill. Each video has at most eight top-level attempts, each with at most ten redirects, plus bounded SDK proxy access checks. All work shares the original run deadline.", "default": "automatic" }, "proxyConfiguration": { "title": "Saved or custom proxy settings", "type": "object", "description": "Optional advanced override. Existing saved/API configurations remain supported and take precedence over Connection. Requests still start directly. Configured managed groups or customer proxy URLs are used only for the existing classified fallback. An explicit useApifyProxy: false without proxyUrls prevents fallback, even when Automatic is selected. To use the simple selector, leave this field unset. No proxy credentials are logged." } } }, "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 } } } } } } } } } }