{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper (+ Metadata)", "description": "Get full YouTube transcripts (timestamped segments and plain text) plus video metadata from videos, channels and playlists. Manual or auto-generated captions, language fallback and auto-translation. Built for AI/RAG, summaries, SEO and content repurposing.", "version": "1.0", "x-build-id": "I9ejMcETMQTbyV0BL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zkill3r~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zkill3r-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/zkill3r~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-zkill3r-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/zkill3r~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-zkill3r-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", "properties": { "videoUrls": { "title": "Videos", "type": "array", "description": "YouTube videos: watch URLs, youtu.be links, /shorts/, /live/ and embed URLs, or bare 11-character video IDs.", "items": { "type": "string" } }, "channelUrls": { "title": "Channels", "type": "array", "description": "Optional. Channel URLs (https://www.youtube.com/@handle, /channel/UC..., /c/..., /user/...) or a bare @handle. The latest uploads are scraped.", "items": { "type": "string" } }, "playlistUrls": { "title": "Playlists", "type": "array", "description": "Optional. Playlist URLs (https://www.youtube.com/playlist?list=...) or playlist IDs.", "items": { "type": "string" } }, "maxVideosPerChannel": { "title": "Max videos per channel", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many of each channel's latest uploads to scrape.", "default": 20 }, "maxVideosPerPlaylist": { "title": "Max videos per playlist", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many videos to scrape from each playlist, in playlist order.", "default": 20 }, "language": { "title": "Transcript language", "type": "string", "description": "Preferred transcript language code, e.g. en, es, ms, pt-BR. \"en\" also matches regional variants like en-GB.", "default": "en" }, "fallbackToAnyLanguage": { "title": "Fall back to any language", "type": "boolean", "description": "If the video has no transcript in your language, return the transcript in whatever language is available instead of status no_transcript.", "default": true }, "translateTo": { "title": "Translate to", "type": "string", "description": "Optional language code (e.g. es). Uses YouTube's own auto-translation when the video offers it; otherwise the original language is returned and the item's error field says so." }, "preferManualCaptions": { "title": "Prefer manual captions", "type": "boolean", "description": "Prefer captions uploaded by the creator over YouTube's auto-generated ones. Turn off to prefer auto-generated captions.", "default": true }, "outputFormat": { "title": "Output format", "enum": [ "both", "segments", "text" ], "type": "string", "description": "\"segments\": timestamped segments only (transcript field); \"text\": plain text only (transcriptText field); \"both\": both fields.", "default": "both" }, "includeMetadata": { "title": "Include video metadata", "type": "boolean", "description": "Add channel, publish date, duration, views, likes, description, thumbnail, Short/live flags. Turn off for transcript only (fewer requests, cheaper).", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many videos are processed in parallel. Lower it if RUN_SUMMARY shows many retries.", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify datacenter proxy by default. Requests YouTube blocks are retried on a new session, and from the 2nd retry on RESIDENTIAL proxy automatically (if your plan includes it).", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }