{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript API & Scraper – Bulk, Playlists, Channels", "description": "Bulk YouTube transcripts for AI/RAG from videos, playlists, channels or search: plain text, timestamped segments, SRT/VTT, chapters and token count. Works from servers. $0.005 per delivered transcript; failures free.", "version": "0.1", "x-build-id": "dMoPEo8j2bnZeZ0ZO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shephouse~youtube-transcript-scraper-bulk/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shephouse-youtube-transcript-scraper-bulk", "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/shephouse~youtube-transcript-scraper-bulk/runs": { "post": { "operationId": "runs-sync-shephouse-youtube-transcript-scraper-bulk", "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/shephouse~youtube-transcript-scraper-bulk/run-sync": { "post": { "operationId": "run-sync-shephouse-youtube-transcript-scraper-bulk", "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": { "startUrls": { "title": "Videos, playlists, channels or searches", "type": "array", "description": "One per line: video URL or 11-character ID, Shorts URL, playlist URL, channel URL or @handle, or a search URL. Plain text is treated as a search.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Optional. Each query adds up to 'Max videos per source' videos from YouTube search.", "items": { "type": "string" } }, "languages": { "title": "Preferred languages", "type": "array", "description": "In order of preference, e.g. en, de. Manual captions are preferred over auto-generated in each language; if none match, the first available track is returned and languageFallbackUsed=true.", "items": { "type": "string" } }, "allowAutoGenerated": { "title": "Allow auto-generated captions", "type": "boolean", "description": "If off, videos with only auto-generated captions return NO_MATCHING_CAPTIONS (not charged).", "default": true }, "outputFormats": { "title": "Extra output formats", "uniqueItems": true, "type": "array", "description": "Plain text is always included. Add timestamped segments, SRT and/or VTT subtitles.", "items": { "type": "string", "enum": [ "text", "segments", "srt", "vtt" ] }, "default": [ "text", "segments" ] }, "splitChapters": { "title": "Split by chapters", "type": "boolean", "description": "If the video has chapters (timestamps in the description), adds chapters[] with the text of each chapter.", "default": true }, "includeDescription": { "title": "Include video description", "type": "boolean", "description": "Adds the video description to each item.", "default": false }, "maxVideosPerSource": { "title": "Max videos per playlist/channel/search", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many videos to take from each playlist, channel (newest first) or search.", "default": 50 }, "maxTranscripts": { "title": "Max delivered transcripts", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stops after this many delivered transcripts (your cost cap: $0.005 each). Free Apify plan: up to 25 per run.", "default": 100 }, "useResidentialProxy": { "title": "Use residential proxy", "type": "boolean", "description": "Recommended: YouTube blocks most datacenter IPs.", "default": true }, "proxyCountry": { "title": "Proxy country (optional)", "type": "string", "description": "Two-letter code, e.g. US. Leave empty for any." }, "maxProxyMegabytes": { "title": "Max proxy traffic (MB)", "minimum": 1, "type": "integer", "description": "Optional safety cap on proxy traffic per run." }, "maxConcurrency": { "title": "Parallel videos", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many videos are fetched at the same time.", "default": 5 } } }, "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 } } } } } } } } } }