{ "openapi": "3.0.1", "info": { "title": "Youtube Transcript", "description": "🎬 EXTRACT YOUTUBE TRANSCRIPTS in seconds. Get timestamped captions in 40+ languages with auto-translation built in. Supports auto-generated subtitles, batch processing and three output formats: segments, full text or [MM:SS]. Built for AI, LLMs and content teams.", "version": "0.1", "x-build-id": "QzG53rjk4Wg6T5lBR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/data_xplorer~youtube-transcript/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-data_xplorer-youtube-transcript", "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/data_xplorer~youtube-transcript/runs": { "post": { "operationId": "runs-sync-data_xplorer-youtube-transcript", "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/data_xplorer~youtube-transcript/run-sync": { "post": { "operationId": "run-sync-data_xplorer-youtube-transcript", "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": [ "videoUrls" ], "properties": { "videoUrls": { "title": "🎬 YouTube Video URLs", "type": "array", "description": "List of YouTube video URLs or video IDs to extract transcripts from.\n\nSupported formats:\n- `https://www.youtube.com/watch?v=VIDEO_ID`\n- `https://youtu.be/VIDEO_ID`\n- `https://www.youtube.com/shorts/VIDEO_ID`\n- Plain 11-character video ID (e.g. `dQw4w9WgXcQ`)", "items": { "type": "string" } }, "preferredLanguage": { "title": "🌍 Preferred language", "enum": [ "en", "fr", "es", "de", "pt", "it", "ru", "ja", "ko", "zh-Hans", "zh-Hant", "ar", "hi", "nl", "pl", "tr", "sv", "da", "no", "fi", "cs", "ro", "hu", "el", "id", "th", "vi", "uk", "he", "fa", "bn", "ms", "ta", "te", "sk", "bg", "hr", "sr", "ca", "af" ], "type": "string", "description": "Language of the transcript to retrieve (ISO 639-1). If unavailable, the actor falls back to the first available track.", "default": "en" }, "customLanguageCode": { "title": "✏️ Custom language code (overrides dropdown)", "type": "string", "description": "If your language is not in the list above, enter any ISO 639-1 code here (e.g. `sw`, `eu`, `lb`). **This field overrides the dropdown when filled.**" }, "outputFormat": { "title": "📄 Output format", "enum": [ "segments", "text", "timestamps" ], "type": "string", "description": "Choose how the transcript is returned:\n\n- **Segments** *(default)* — structured array `[{ start, duration, end, text }]` with times in seconds\n- **Full text** — one continuous plain-text string\n- **Full text with timestamps** — line-by-line `[MM:SS] text`", "default": "segments" }, "proxyConfiguration": { "title": "🔒 Proxy configuration", "type": "object", "description": "⚠️ **Residential proxy required.** YouTube blocks datacenter IPs on its InnerTube API.\n\nRecommended: enable **Apify Residential** proxy. Datacenter proxies will not work." } } }, "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 } } } } } } } } } }