{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper: Chapters, Channels & Playlists", "description": "Scrape YouTube transcripts and subtitles from videos, channels, playlists and searches, split into the video chapters for AI. Text, SRT, VTT, Markdown. $0.50 per 1,000, failed videos free.", "version": "0.1", "x-build-id": "6vVr9G7mb6sLMZXZ8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/farovin~youtube-transcripts/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-farovin-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/farovin~youtube-transcripts/runs": { "post": { "operationId": "runs-sync-farovin-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/farovin~youtube-transcripts/run-sync": { "post": { "operationId": "run-sync-farovin-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": { "videos": { "title": "Videos, channels or playlists", "type": "array", "description": "YouTube video links or IDs, channel links (@handle, /channel/, /c/) or playlist links. Channels and playlists are expanded into their videos.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Get transcripts of the top videos YouTube returns for each search, e.g. \"how to bake bread\".", "items": { "type": "string" } }, "maxVideosPerSource": { "title": "Max videos per channel, playlist or search", "minimum": 1, "type": "integer", "description": "How many videos to take from each channel (newest first), playlist or search query.", "default": 50 }, "publishedWithinDays": { "title": "Only videos from the last N days", "minimum": 1, "type": "integer", "description": "For channels, playlists and searches: skip videos older than this. Uses the upload age YouTube shows in the list (e.g. \"3 weeks ago\"), so it is approximate. Skipped videos cost nothing." }, "includeShorts": { "title": "Include Shorts", "type": "boolean", "description": "Turn off to skip YouTube Shorts when reading channels, playlists and searches.", "default": true }, "languagesOnly": { "title": "Only list available languages (free)", "type": "boolean", "description": "Do not download transcripts; just list which caption languages each video has. Free.", "default": false }, "chapters": { "title": "Split transcript into chapters", "enum": [ "chapters-or-sections", "chapters-only", "off" ], "type": "string", "description": "Adds a \"sections\" list with title, start, end and the text of each part. Ready for AI summaries, search and RAG.", "default": "chapters-or-sections" }, "sectionMinutes": { "title": "Section length (minutes)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Length of each time section when a video has no creator chapters.", "default": 5 }, "languages": { "title": "Preferred languages", "type": "array", "description": "Language codes in order of preference, e.g. 'en', 'es', 'el'. If none is available, English is tried, then the first available transcript.", "items": { "type": "string" } }, "includeAutoGenerated": { "title": "Include auto-generated captions", "type": "boolean", "description": "Use YouTube's automatic captions when no human-made transcript exists. Most videos only have auto-generated captions.", "default": true }, "outputFormats": { "title": "Output formats", "type": "array", "description": "text = full transcript as one string. timestamped = lines with [mm:ss]. segments = list with start and duration. srt / vtt = subtitle files. markdown = LLM-ready document with one heading per chapter.", "items": { "type": "string", "enum": [ "text", "timestamped", "segments", "srt", "vtt", "markdown" ] }, "default": [ "text", "segments" ] }, "maxVideos": { "title": "Max videos", "minimum": 1, "type": "integer", "description": "Stop after this many videos. Also caps the cost of a run.", "default": 1000 }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many videos to process at the same time.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave as is. Residential proxy is required because YouTube blocks cloud servers, and its cost is already 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 } } } } } } } } } }