{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript API", "description": "Extract transcripts, captions, and subtitles from YouTube videos. Supports 100+ languages, auto-generated captions, SRT/VTT export, playlists, and channels.", "version": "0.1", "x-build-id": "C8cj1y1KOAROSTHVD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/glassventures~youtube-transcript-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-glassventures-youtube-transcript-api", "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/glassventures~youtube-transcript-api/runs": { "post": { "operationId": "runs-sync-glassventures-youtube-transcript-api", "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/glassventures~youtube-transcript-api/run-sync": { "post": { "operationId": "run-sync-glassventures-youtube-transcript-api", "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": { "startUrls": { "title": "YouTube URLs", "type": "array", "description": "YouTube video, playlist, or channel URLs. The actor auto-detects the URL type and extracts transcripts from all discovered videos.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "videoIds": { "title": "Video IDs", "type": "array", "description": "Direct YouTube video IDs (11-character strings). Faster than full URLs.", "items": { "type": "string" } }, "searchTerms": { "title": "Search Terms", "type": "array", "description": "Search YouTube for these terms and extract transcripts from the results.", "items": { "type": "string" } }, "language": { "title": "Preferred Language", "enum": [ "en", "es", "fr", "de", "pt", "it", "nl", "ru", "ja", "ko", "zh", "ar", "hi", "tr", "pl", "sv", "id", "th", "vi", "cs" ], "type": "string", "description": "ISO language code for the transcript. Falls back to any available language if not found.", "default": "en" }, "includeAutoGenerated": { "title": "Include Auto-Generated Captions", "type": "boolean", "description": "If enabled, auto-generated (speech-to-text) captions are used when manual captions are not available.", "default": true }, "translationLanguage": { "title": "Translate To", "type": "string", "description": "Translate the transcript to this language using YouTube's built-in translation. Leave empty to use original language." }, "outputFormat": { "title": "Output Format", "enum": [ "json", "plaintext", "srt", "vtt" ], "type": "string", "description": "Format for the transcript output. JSON includes timestamps, plaintext is just text.", "default": "json" }, "includeTimestamps": { "title": "Include Timestamps", "type": "boolean", "description": "Include start time and duration for each transcript segment (JSON format only).", "default": true }, "includeVideoMetadata": { "title": "Include Video Metadata", "type": "boolean", "description": "Include video title, channel, views, publish date, description, and thumbnail URL.", "default": true }, "maxItems": { "title": "Max Videos", "minimum": 0, "type": "integer", "description": "Maximum number of video transcripts to extract. Use 0 for unlimited.", "default": 50 }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum parallel requests. YouTube has generous rate limits, so 10-20 works well.", "default": 10 }, "debugMode": { "title": "Debug Mode", "type": "boolean", "description": "Enables verbose logging for troubleshooting.", "default": false }, "proxyConfig": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Residential proxies are recommended for YouTube to avoid bot detection." } } }, "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 } } } } } } } } } }