{
"openapi": "3.0.1",
"info": {
"title": "YouTube Transcript Scraper: YouTube Captions & Subtitles",
"description": "Get YouTube transcripts, subtitles and captions as text with timestamps from video, Shorts, channel or playlist URLs. Pick languages, manual or auto-generated captions. Includes title, channel, views, likes and publish date. Pay only per transcript; videos without captions are free.",
"version": "0.2",
"x-build-id": "JOZRYCA3IemnFZdfa"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/xmolodtsov~youtube-transcript-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-xmolodtsov-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/xmolodtsov~youtube-transcript-scraper/runs": {
"post": {
"operationId": "runs-sync-xmolodtsov-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/xmolodtsov~youtube-transcript-scraper/run-sync": {
"post": {
"operationId": "run-sync-xmolodtsov-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": {
"urls": {
"title": "YouTube URLs or video IDs",
"type": "array",
"description": "Required. One per line, mixed freely: video, Shorts or live URLs (watch?v=, youtu.be/, /shorts/, /live/, /embed/), 11-character video IDs, channel URLs or @handles (the channel's latest uploads from its Videos tab), or playlist URLs. Duplicate videos are fetched once. Free Apify plan: at most 10 videos per run in total, 5 runs per calendar month (a limit set by the developer, not by Apify).",
"items": {
"type": "string"
}
},
"maxVideosPerChannel": {
"title": "Max videos per channel or playlist",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "How many of the latest videos to take from each channel or playlist URL (channels: newest uploads first; a channel's Shorts tab is not included). Single video URLs are not affected. Free Apify plan: a run returns at most 10 videos in total, whatever this value (a limit set by the developer, not by Apify).",
"default": 10
},
"languages": {
"title": "Preferred languages",
"type": "array",
"description": "Caption language codes in order of preference, e.g. en, es, de. The first one the video has wins; \"en\" also matches regional variants such as en-GB. Captions are not translated: pick languages the video already has (the output's available_languages lists them).",
"default": [
"en"
],
"items": {
"type": "string"
}
},
"captionType": {
"title": "Caption type",
"enum": [
"any",
"manual",
"auto"
],
"type": "string",
"description": "Any: human-made subtitles first, auto-generated captions otherwise. Manual only: human-made subtitles only. Auto-generated only: captions from YouTube's speech recognition only. The output's is_auto_generated field shows which one you got.",
"default": "any"
},
"fallbackToAnyLanguage": {
"title": "Fall back to the video's own language",
"type": "boolean",
"description": "When none of your preferred languages exists, return the transcript in the video's original language. Off: such videos get a free language_not_found row instead.",
"default": true
},
"includeTimestamps": {
"title": "Include timestamped segments",
"type": "boolean",
"description": "Add the transcript field: segments with start, end and duration in seconds. The plain-text transcript_text is always included; turn this off for smaller results.",
"default": true
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Optional. A residential proxy is built in and included in the price, so leave this as is. Change it only to route requests through your own proxies; YouTube blocks most datacenter IPs."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}