{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper", "description": "Extract YouTube video transcripts with timestamps, metadata, and LLM-ready text from individual URLs, bulk lists, channels, or search queries.", "version": "1.0", "x-build-id": "DD2f1H4QpEnJxJMm6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~youtube-transcript-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-youtube-transcript-extractor", "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/khadinakbar~youtube-transcript-extractor/runs": { "post": { "operationId": "runs-sync-khadinakbar-youtube-transcript-extractor", "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/khadinakbar~youtube-transcript-extractor/run-sync": { "post": { "operationId": "run-sync-khadinakbar-youtube-transcript-extractor", "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": "Video URLs", "type": "array", "description": "One or more YouTube video URLs. Supports youtube.com/watch, youtu.be, Shorts, and embed links.", "items": { "type": "string" } }, "channelUrl": { "title": "Channel URL or @handle", "type": "string", "description": "A YouTube channel URL or @handle (e.g. @mkbhd). Extracts transcripts from the channel's videos." }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Search YouTube by keyword and extract transcripts from the top results." }, "maxResults": { "title": "Max videos", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of videos to process. Default 10.", "default": 10 }, "language": { "title": "Transcript language", "type": "string", "description": "Preferred transcript language (ISO 639-1 code, e.g. 'en', 'es', 'fr'). Falls back to English if unavailable.", "default": "en" }, "dateFrom": { "title": "Published after", "type": "string", "description": "Only include videos published on or after this date (YYYY-MM-DD). Channel and search modes only." }, "dateTo": { "title": "Published before", "type": "string", "description": "Only include videos published on or before this date (YYYY-MM-DD). Channel and search modes only." }, "includeMetadata": { "title": "Include video metadata", "type": "boolean", "description": "Fetch title, views, likes, channel info, tags, and thumbnail. Disable for faster runs if you only need transcript text.", "default": true }, "outputFormat": { "title": "Transcript format", "enum": [ "all", "segments", "plain_text", "srt" ], "type": "string", "description": "Which transcript formats to return: 'all' (segments + plain text + SRT + LLM context), 'segments' (timestamped only), 'plain_text' (text + LLM context), or 'srt' (subtitle format).", "default": "all" }, "customProxyUrl": { "title": "Custom proxy URL", "type": "string", "description": "Optional rotating residential proxy (e.g. http://user:pass@host:port). Overrides Apify proxy if set." }, "proxyConfiguration": { "title": "Apify proxy", "type": "object", "description": "Apify proxy settings. Residential proxy is required — datacenter IPs are blocked by YouTube.", "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 } } }, "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 } } } } } } } } } }