{ "openapi": "3.0.1", "info": { "title": "YouTube Transcripts: Videos, Playlists & Channels", "description": "Get YouTube transcripts as clean text, timestamped segments, SRT, or AI-ready chunks for RAG. Paste videos, whole playlists or channels, pick your languages, and never pay for videos without captions.", "version": "1.0", "x-build-id": "btWDkZLmg5NrJwCkY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/t3data~youtube-transcripts/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-t3data-youtube-transcripts", "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/t3data~youtube-transcripts/runs": { "post": { "operationId": "runs-sync-t3data-youtube-transcripts", "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/t3data~youtube-transcripts/run-sync": { "post": { "operationId": "run-sync-t3data-youtube-transcripts", "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": [ "urls" ], "properties": { "urls": { "title": "YouTube URLs", "type": "array", "description": "Video URLs (watch, youtu.be, Shorts, live), plain video IDs, playlist URLs, or channel URLs (@handle, /channel/UC…). Playlists and channels are expanded to their videos.", "items": { "type": "string" } }, "languages": { "title": "Preferred languages", "type": "array", "description": "Language codes in order of preference (e.g. en, es, de). If none match, the video's own language is used.", "default": [ "en" ], "items": { "type": "string" } }, "preferManualCaptions": { "title": "Prefer human-made captions", "type": "boolean", "description": "Use creator-uploaded captions over auto-generated ones when both exist.", "default": true }, "maxVideosPerPlaylist": { "title": "Max videos per playlist / channel", "minimum": 1, "maximum": 5000, "type": "integer", "description": "For channels, the most recent uploads are taken first.", "default": 50 }, "includeSegments": { "title": "Include timestamped segments", "type": "boolean", "description": "Adds a `segments` array with start time, duration and text for each caption line.", "default": true }, "includeSrt": { "title": "Include SRT subtitles", "type": "boolean", "description": "Adds a ready-to-save `srt` field.", "default": false }, "includeDescription": { "title": "Include video description", "type": "boolean", "description": "Adds the full video description text.", "default": false }, "includeChunks": { "title": "AI-ready chunks (for RAG / embeddings)", "type": "boolean", "description": "Adds a `chunks` array: the transcript split into overlapping pieces of about N words, each with start/end time, a timestamped video link and video metadata. Drop straight into a vector database. No extra cost.", "default": false }, "chunkMaxWords": { "title": "Words per chunk", "minimum": 20, "maximum": 5000, "type": "integer", "description": "Target size of each chunk in words (about 1.3 tokens per word). 200–400 works well for most embedding models.", "default": 300 }, "chunkOverlapWords": { "title": "Overlap between chunks (words)", "minimum": 0, "maximum": 1000, "type": "integer", "description": "How many words of the previous chunk to repeat at the start of the next, so context isn't cut mid-thought. 0 disables overlap.", "default": 30 }, "maxConcurrency": { "title": "Parallel videos", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many videos to process at the same time.", "default": 25 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential proxy is strongly recommended — YouTube blocks datacenter IPs. Proxy cost is included in the price.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }