{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper: AI Chunks, SRT & VTT", "description": "Get the transcript of any YouTube video, Short, live replay, playlist or channel. Input: video, playlist or channel links. Output: clean text, timestamped lines, AI-ready chunks for RAG, SRT or VTT. Use it to summarize, search or quote videos. Picks the spoken language. Pay per transcript.", "version": "0.0", "x-build-id": "mXheV4C9mGETB1OdZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sblabs~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sblabs-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/sblabs~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-sblabs-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/sblabs~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-sblabs-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", "required": [ "videos" ], "properties": { "videos": { "title": "YouTube videos, playlists or channels", "type": "array", "description": "Video links or 11-character IDs, playlist links (youtube.com/playlist?list=...), or channel links (@handle, /channel/UC..., /c/..., /user/...). Playlists and channels are expanded into their videos; duplicates are removed. Listing videos is free: you only pay for transcripts delivered.", "items": { "type": "string" } }, "maxVideosPerSource": { "title": "Max videos per playlist or channel", "minimum": 0, "maximum": 5000, "type": "integer", "description": "For each playlist or channel, take at most this many videos (channels: newest first). 0 means all, up to 5,000.", "default": 50 }, "channelContent": { "title": "Channel videos to include", "enum": [ "videos", "shorts", "streams", "all" ], "type": "string", "description": "Which uploads to take from channel links. A link ending in /shorts or /streams overrides this. Shorts are limited to the latest 100.", "default": "videos" }, "language": { "title": "Preferred language", "type": "string", "description": "ISO language code such as en, de or es. If the video has captions in this language they are used; otherwise you get the captions in the video's spoken language. Leave empty for the spoken language." }, "chunkSize": { "title": "AI chunk size (characters)", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Splits the transcript into chunks of about this many characters, each with start and end time. Ready for embeddings and RAG. Set 0 to turn chunks off.", "default": 1000 }, "includeTimestamps": { "title": "Include timestamped segments", "type": "boolean", "description": "Adds every caption line with its start time and duration.", "default": true }, "includeSrt": { "title": "Include SRT subtitles", "type": "boolean", "description": "Adds the transcript as an .srt subtitle string.", "default": false }, "includeVtt": { "title": "Include WebVTT subtitles", "type": "boolean", "description": "Adds the transcript as a WebVTT (.vtt) subtitle string.", "default": false }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many videos to fetch at the same time.", "default": 5 }, "maxRetries": { "title": "Retries per video", "minimum": 0, "maximum": 6, "type": "integer", "description": "Extra attempts with a fresh IP when YouTube blocks a request or the connection drops.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "YouTube blocks datacenter IPs for transcripts, so residential proxy is the default and recommended setting.", "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 } } } } } } } } } }