{
"openapi": "3.0.1",
"info": {
"title": "YouTube Transcript Scraper: Video to Text, Subtitles & SRT",
"description": "YouTube transcript scraper: turn any YouTube video, Short, playlist or channel into text. Get captions and subtitles as plain text, with timestamps or as SRT, plus title, channel, views and upload date. No login, no API key. Pay per video.",
"version": "0.1",
"x-build-id": "Je3F9G3WvZEfsdgXW"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/quillstone-labs~youtube-transcript-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-quillstone-labs-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/quillstone-labs~youtube-transcript-scraper/runs": {
"post": {
"operationId": "runs-sync-quillstone-labs-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/quillstone-labs~youtube-transcript-scraper/run-sync": {
"post": {
"operationId": "run-sync-quillstone-labs-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": {
"videos": {
"title": "YouTube videos, playlists or channels",
"type": "array",
"description": "One per line. A video link (https://www.youtube.com/watch?v=dQw4w9WgXcQ), a short link (https://youtu.be/...), a Shorts or live link, or just the 11-character video ID. A playlist link or a channel (@handle or its link, add /shorts for its Shorts) brings in its newest videos, up to the limit below. Through the API you can also pass objects like { \"url\": \"...\" }.",
"items": {
"type": "string"
}
},
"searchQueries": {
"title": "Search YouTube",
"type": "array",
"description": "Optional. Get transcripts of the top videos for a search, like sourdough bread recipe. Each search brings in up to the limit below.",
"items": {
"type": "string"
}
},
"maxVideosPerSource": {
"title": "Videos per playlist, channel or search",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "How many videos to take from each playlist, channel or search, newest first for channels. Listing them is free; you only pay for the videos read.",
"default": 20
},
"languages": {
"title": "Preferred caption languages",
"type": "array",
"description": "Optional, like en or es. When a video has captions in one of these languages, that track is used, the creator's own before YouTube's automatic ones. Leave empty to get the language spoken in the video.",
"items": {
"type": "string"
}
},
"includeTimestamps": {
"title": "Include timestamps and SRT subtitles",
"type": "boolean",
"description": "Also return the captions line by line with start and end times in seconds, plus the same as a ready-made SRT subtitle file in the srt field. Off by default to keep results short.",
"default": false
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "YouTube asks many server addresses to prove they're not a bot. Apify Proxy switches address when that happens.",
"default": {
"useApifyProxy": true
}
},
"residentialFallback": {
"title": "Retry refused videos on a residential connection",
"type": "boolean",
"description": "When YouTube keeps refusing a video on the normal connection, try it twice more on Apify's residential proxy. No extra charge to you.",
"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
}
}
}
}
}
}
}
}
}
}