{
"openapi": "3.0.1",
"info": {
"title": "YouTube Transcript Scraper – Captions, Subtitles & Video Data",
"description": "YouTube transcript scraper: get the full transcript, captions or subtitles of any public YouTube video, with timestamps, in any available language (human-made or auto-generated), plus video title, channel, views, duration and publish date. No login or API key.",
"version": "1.0",
"x-build-id": "q6jWd1xng85fVybQ8"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/openharvest~youtube-transcript-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-openharvest-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/openharvest~youtube-transcript-scraper/runs": {
"post": {
"operationId": "runs-sync-openharvest-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/openharvest~youtube-transcript-scraper/run-sync": {
"post": {
"operationId": "run-sync-openharvest-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",
"type": "array",
"description": "Video URLs or 11-character video IDs. Accepted formats: https://www.youtube.com/watch?v=jNQXAC9IVRw, https://youtu.be/jNQXAC9IVRw, https://www.youtube.com/shorts/..., /live/..., /embed/... or just jNQXAC9IVRw. Channel and playlist links are not supported - enter the individual videos.",
"default": [
"https://www.youtube.com/watch?v=jNQXAC9IVRw"
],
"items": {
"type": "string"
}
},
"language": {
"title": "Transcript language",
"type": "string",
"description": "Optional language code, e.g. en, de, es, pt-BR, ja. Leave empty to get the video's original (spoken) language. Human-made captions in this language are preferred over auto-generated ones."
},
"captionType": {
"title": "Caption type",
"enum": [
"any",
"manual",
"auto"
],
"type": "string",
"description": "Any prefers human-made captions and falls back to auto-generated (speech recognition) captions. Human-made only and Auto-generated only restrict the choice.",
"default": "any"
},
"languageFallback": {
"title": "Fall back to original language",
"type": "boolean",
"description": "If the video has no captions in Transcript language, return the transcript in the video's original language (marked with requestedLanguageMissing: true). Turn off to get a free error row instead.",
"default": true
},
"includeTimestamps": {
"title": "Include timestamped segments",
"type": "boolean",
"description": "Add the segments array (start time, duration and text of every caption line). The plain-text transcript field is always included.",
"default": true
},
"includeMetadata": {
"title": "Include video metadata",
"type": "boolean",
"description": "Add publish date, duration, view count, category, keywords (tags), description and thumbnail URL. Title and channel are always included.",
"default": true
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Leave off. On the Apify platform the Actor already uses Apify residential proxy (YouTube blocks datacenter IPs) and rotates IPs automatically - the proxy cost is included in the price. Set a custom proxy only if you want to use your own.",
"default": {
"useApifyProxy": false
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}