{
"openapi": "3.0.1",
"info": {
"title": "YouTube Transcript Scraper",
"description": "Transcripts of YouTube videos, playlists and whole channels in the language you ask for, with timestamps, SRT/VTT and video metadata. Every video gets a row that says why when there is no transcript. No login, no browser.",
"version": "1.0",
"x-build-id": "StZLVOnc8DR5B0qKv"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/steadyscrape~youtube-transcript-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-steadyscrape-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/steadyscrape~youtube-transcript-scraper/runs": {
"post": {
"operationId": "runs-sync-steadyscrape-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/steadyscrape~youtube-transcript-scraper/run-sync": {
"post": {
"operationId": "run-sync-steadyscrape-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",
"required": [
"urls"
],
"properties": {
"urls": {
"title": "Videos, playlists or channels",
"type": "array",
"description": "One per line: a video link in any shape (watch?v=, youtu.be, Shorts, live, embed) or a bare video id; a playlist link or id; a channel link (@handle, /channel/UC…, /c/, /user/) or a bare @handle. A playlist or channel expands to its videos, newest first for channels.",
"items": {
"type": "string"
}
},
"language": {
"title": "Language",
"type": "string",
"description": "Caption language to read, as a code (en, es, pt-BR). A short code matches a regional track (pt finds pt-BR). Empty: the track YouTube shows by default for the video."
},
"whenLanguageMissing": {
"title": "When the language is missing",
"enum": [
"default-track",
"skip"
],
"type": "string",
"description": "What to do with a video that has captions but none in the requested language. Either read its default track (the row's language tells which one) or skip it with status language_missing and the languages it does have.",
"default": "default-track"
},
"preferAutoGenerated": {
"title": "Prefer auto-generated captions",
"type": "boolean",
"description": "When a video has both a manual and an auto-generated track in the language, read the auto-generated one. Off: the manual one wins, auto-generated is the fallback.",
"default": false
},
"formats": {
"title": "Formats",
"type": "array",
"description": "Which renderings of the transcript to include in each row: plain text, timed segments (start and duration in seconds), srt and vtt subtitle files as strings.",
"items": {
"type": "string",
"enum": [
"text",
"segments",
"srt",
"vtt"
],
"enumTitles": [
"Plain text",
"Timed segments",
"SRT",
"WebVTT"
]
},
"default": [
"text",
"segments"
]
},
"maxVideosPerSource": {
"title": "Max videos per playlist or channel",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "Stop expanding each playlist or channel after this many videos. Videos given directly are not counted.",
"default": 100
},
"residentialFallback": {
"title": "Residential proxy fallback",
"type": "boolean",
"description": "YouTube lets about half of datacenter IPs through. A video refused on the direct route and on a datacenter proxy is retried through Apify's residential proxy (a few KB per video, charged by Apify as proxy traffic). Off: such videos end with status blocked.",
"default": 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
}
}
}
}
}
}
}
}
}
}