{
"openapi": "3.0.1",
"info": {
"title": "YouTube Transcript Scraper 📝 Subtitles, Timestamps & SRT",
"description": "Quickly get the full transcript of any YouTube video as clean text, timestamped cues or an SRT file. Works on manual and auto-generated captions in any language. No cookies, no login, no API key. Accurate and reliable whilst maintaining maximum speed.",
"version": "0.0",
"x-build-id": "yde1ssRohx6LuI45Z"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/gatherworks~youtube-transcript-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-gatherworks-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/gatherworks~youtube-transcript-scraper/runs": {
"post": {
"operationId": "runs-sync-gatherworks-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/gatherworks~youtube-transcript-scraper/run-sync": {
"post": {
"operationId": "run-sync-gatherworks-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": [
"videoUrls"
],
"properties": {
"videoUrls": {
"title": "YouTube video URLs",
"type": "array",
"description": "Video links or IDs. Accepts watch URLs, youtu.be links, Shorts URLs and bare 11-character IDs.",
"items": {
"type": "string"
}
},
"preferredLanguages": {
"title": "Preferred languages",
"type": "array",
"description": "Two-letter language codes in order of preference, e.g. en, es, de. The first available one is used.",
"items": {
"type": "string"
}
},
"allowAutoGenerated": {
"title": "Allow auto-generated captions",
"type": "boolean",
"description": "Use YouTube's automatic captions when no human-written track exists. Turn off to only accept manual subtitles.",
"default": true
},
"filter": {
"title": "Filter",
"type": "object",
"description": "Only keep rows matching these conditions. Rows that do not match are not returned and are not charged for. Example: {\"wordCount\": {\"gte\": 200}, \"isAutoGenerated\": false, \"status\": \"ok\"}. Operators: eq, ne, gt, gte, lt, lte, contains, notContains, startsWith, endsWith, matches, in, notIn, exists, before, after."
},
"sortResultsBy": {
"title": "Sort results by",
"type": "string",
"description": "Order the returned rows, e.g. wordCount:desc or videoTitle:asc. Leave empty to keep input order."
},
"useCache": {
"title": "Reuse recent results",
"type": "boolean",
"description": "Serve a video you have already fetched from your own recent copy instead of fetching it again. Captions rarely change, so this is faster and cheaper. Turn it off to force a fresh fetch every time.",
"default": true
},
"cacheHours": {
"title": "How long to reuse a result",
"minimum": 1,
"maximum": 720,
"type": "integer",
"description": "Hours before a stored result is considered old and fetched again. Default is one week."
},
"includeTimestamps": {
"title": "Include timestamped cues",
"type": "boolean",
"description": "Adds a cues array with the start time and duration of every line. Billed as an add-on.",
"default": false
},
"includeSrt": {
"title": "Include SRT subtitle file",
"type": "boolean",
"description": "Adds a ready-to-use SRT string for subtitle pipelines. Billed as an add-on.",
"default": false
},
"concurrency": {
"title": "Concurrent videos",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "How many videos to fetch at once. Raise it for a large list, lower it if you prefer a steadier run.",
"default": 5
},
"country": {
"title": "Country",
"type": "string",
"description": "Two-letter country code for the region to use.",
"default": "US"
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Optional proxy settings. Leave as they are unless you have a reason to change them."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}