{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript API", "description": "Get YouTube transcripts in supplied languages from videos, Shorts, channels and playlists. Export segments, plain text and video metadata.", "version": "0.1", "x-build-id": "ZHUIEmbVefyUi3qXI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/danthedataman~youtube-transcript-language-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-danthedataman-youtube-transcript-language-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/danthedataman~youtube-transcript-language-api/runs": { "post": { "operationId": "runs-sync-danthedataman-youtube-transcript-language-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/danthedataman~youtube-transcript-language-api/run-sync": { "post": { "operationId": "run-sync-danthedataman-youtube-transcript-language-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": { "sources": { "title": "Video IDs, video URLs, channels or playlists", "type": "array", "description": "YouTube video IDs or HTTPS watch, youtu.be, Shorts, live or embed URLs; @handle or /channel/ID channel URLs; or /playlist?list=ID URLs. Omitted, null or empty means no work.", "items": { "type": "string" } }, "maxVideosPerSource": { "title": "Maximum videos inspected per source", "minimum": 0, "maximum": 200, "type": "integer", "description": "Inspect at most this many distinct video IDs per channel or playlist in source order. Failed, filtered and duplicate-in-run videos consume the source bound. Zero means no work. Single-video sources inspect one video. Range 0–200.", "default": 10 }, "preferredLanguages": { "title": "Caption languages in fallback order", "type": "array", "description": "Try supplied caption language codes in this order, manual before auto within each language. If no preference matches, use the unique source default when eligible. If that default exists but is ineligible, use the first eligible track. If no unique source default exists, report CAPTION_SELECTION. No translation is requested.", "items": { "type": "string" }, "default": [] }, "includeAutoGenerated": { "title": "Include auto-generated captions", "type": "boolean", "description": "Allow auto-generated caption tracks. False excludes them; a video with only auto captions goes to ERRORS.", "default": true }, "includeSegments": { "title": "Include timestamped segments", "type": "boolean", "description": "Include segments with start and duration in seconds. Missing source duration is null. Captions are still fetched and validated when false.", "default": true }, "includePlainText": { "title": "Include plain text", "type": "boolean", "description": "Include plainText by joining nonempty source paragraphs with newlines. Captions are still validated when false.", "default": true }, "startDate": { "title": "Published on or after", "type": "string", "description": "Optional inclusive UTC calendar date YYYY-MM-DD or ISO timestamp with timezone. Applies within the per-source bound. Missing source publication time goes to ERRORS when filtering.", "default": "" }, "endDate": { "title": "Published on or before", "type": "string", "description": "Optional inclusive UTC calendar date YYYY-MM-DD (whole day) or ISO timestamp with timezone. Must not precede startDate.", "default": "" } } }, "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 } } } } } } } } } }