{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper", "description": "Transcripts from YouTube videos, Shorts, whole channels and playlists, with timestamps, SRT/VTT and AI-ready chunks. Watch channels for new videos on a schedule. Pay only for transcripts delivered.", "version": "0.1", "x-build-id": "g3wXaeMgln1nG0feY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/leanpilar~youtube-transcripts/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-leanpilar-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/leanpilar~youtube-transcripts/runs": { "post": { "operationId": "runs-sync-leanpilar-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/leanpilar~youtube-transcripts/run-sync": { "post": { "operationId": "run-sync-leanpilar-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", "properties": { "urls": { "title": "Videos, channels or playlists", "type": "array", "description": "One per line. Video links (watch, youtu.be, Shorts, live), video IDs, channel links or @handles, and playlist links all work.", "items": { "type": "string" } }, "languages": { "title": "Preferred languages", "type": "array", "description": "Language codes in order of preference, for example en, de, hr. Human-made captions are preferred over auto-generated ones. Leave empty to get the language the video is spoken in.", "default": [], "items": { "type": "string" } }, "fallbackToAnyLanguage": { "title": "If none of these languages exist, use the spoken language", "type": "boolean", "description": "When off, videos without a transcript in your languages are returned as noTranscript and not charged.", "default": true }, "allLanguages": { "title": "Get every available language", "type": "boolean", "description": "Return one transcript per language the video has (filtered by Preferred languages if you set any). Each transcript is charged.", "default": false }, "outputFormats": { "title": "Output formats", "type": "array", "description": "text: the whole transcript as one string. segments: lines with start time and duration in seconds. srt and vtt: subtitle files. chunks: passages of up to ~1,500 characters with start time and a link to that moment, ready for AI tools and search.", "items": { "type": "string", "enum": [ "text", "segments", "srt", "vtt", "chunks" ], "enumTitles": [ "Plain text", "Timestamped segments", "SRT subtitles", "WebVTT subtitles", "AI-ready chunks with timestamp links" ] }, "default": [ "text", "segments" ] }, "chunkMaxChars": { "title": "Chunk size (characters)", "minimum": 200, "maximum": 20000, "type": "integer", "description": "Maximum length of each chunk when the chunks format is selected.", "default": 1500 }, "maxVideosPerSource": { "title": "Max videos per channel or playlist", "minimum": 1, "maximum": 5000, "type": "integer", "description": "For channels, the newest videos come first.", "default": 20 }, "channelTabs": { "title": "Channel content", "type": "array", "description": "Which channel tabs to read.", "items": { "type": "string", "enum": [ "videos", "shorts", "streams" ], "enumTitles": [ "Videos", "Shorts", "Live streams" ] }, "default": [ "videos" ] }, "onlyNewVideos": { "title": "Only new videos (for scheduled runs)", "type": "boolean", "description": "Skip videos this monitor already delivered in earlier runs. Schedule the actor daily to get transcripts of new uploads only.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Keeps separate memory of delivered videos per name, so different schedules do not affect each other.", "default": "default" }, "includeVideoDetails": { "title": "Include video details", "type": "boolean", "description": "Title, channel, duration, views, description, keywords and thumbnail. Free.", "default": true }, "maxConcurrency": { "title": "Parallel videos", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many videos to fetch at the same time.", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "YouTube blocks most datacenter IPs. Residential is the default and 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 } } } } } } } } } }