{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper", "description": "Get the transcript of any YouTube video by URL or ID. Returns plain text and timed segments in any available caption language, with SRT and VTT output, auto vs manual caption flags and chapters. No API key needed.", "version": "0.1", "x-build-id": "hAiq6jgv5UgHg1jto" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/serentity~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-serentity-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/serentity~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-serentity-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/serentity~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-serentity-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": "Video URLs or IDs", "minItems": 1, "maxItems": 10000, "uniqueItems": true, "type": "array", "description": "YouTube video URLs or 11-character video IDs. Accepts watch, youtu.be, Shorts, embed and live URLs. One transcript is returned per video.", "items": { "type": "string" } }, "languages": { "title": "Preferred languages", "type": "array", "description": "Caption language codes in order of preference, for example en, en-US, de, es. The first language the video has is used. Leave empty to take the video's default track.", "default": [ "en" ], "items": { "type": "string" } }, "preferManual": { "title": "Prefer manual captions", "type": "boolean", "description": "When a language has both creator-uploaded and auto-generated captions, use the creator-uploaded ones.", "default": true }, "fallbackToAnyLanguage": { "title": "Fall back to any language", "type": "boolean", "description": "If none of the preferred languages exists, return the video's default caption track instead of a LANGUAGE_NOT_AVAILABLE error.", "default": true }, "translateTo": { "title": "Translate to", "type": "string", "description": "Optional. A language code (for example bs, de, ja) to request YouTube's automatic translation of the chosen track. Best effort: YouTube does not offer translation for every track or from every network, so the original transcript is returned with a translationError field when translation is refused." }, "includeSegments": { "title": "Include timed segments", "type": "boolean", "description": "Include the segments array with start time, duration and text of every caption line.", "default": true }, "includeSrt": { "title": "Include SRT", "type": "boolean", "description": "Add the transcript as an SRT subtitle string in the srt field.", "default": false }, "includeVtt": { "title": "Include WebVTT", "type": "boolean", "description": "Add the transcript as a WebVTT subtitle string in the vtt field.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many videos are fetched at the same time.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy used for the requests. Apify datacenter proxies are used by default.", "default": { "useApifyProxy": true } }, "residentialFallback": { "title": "Residential proxy fallback", "type": "boolean", "description": "If YouTube blocks the datacenter proxy for a video, retry that video through Apify residential proxies. Residential traffic is small (about 0.1 to 0.3 MB per video) and is only used when a block is detected.", "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 } } } } } } } } } }