{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper", "description": "Get YouTube video and Shorts transcripts as plain text, timed segments or SRT, with title, channel, views and publish date. Pick languages in priority order. Videos without captions are never charged.", "version": "1.0", "x-build-id": "HKp1In993HTW7CgRk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cairnware~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cairnware-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/cairnware~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-cairnware-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/cairnware~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-cairnware-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": [ "videos" ], "properties": { "videos": { "title": "YouTube videos", "type": "array", "description": "Video links in any format (youtube.com/watch?v=..., youtu.be/..., /shorts/..., /embed/..., /live/..., m.youtube.com, music.youtube.com) or bare video IDs, one per line. Duplicates are removed.", "items": { "type": "string" } }, "languages": { "title": "Preferred languages", "type": "array", "description": "Caption languages in order of preference, as codes like en, es, de, pt-BR, zh-Hans. \"en\" also matches regional variants such as en-GB. For each language, captions written by the uploader are preferred over auto-generated ones. Leave empty to get each video's original language.", "default": [ "en" ], "items": { "type": "string" } }, "fallbackToAnyLanguage": { "title": "Fall back to the original language", "type": "boolean", "description": "If a video has no captions in your preferred languages, return its original-language transcript instead (the row gets a warning). Turn off to get status \"no_transcript\" (not charged) for such videos.", "default": true }, "includeAutoGenerated": { "title": "Include auto-generated captions", "type": "boolean", "description": "Use YouTube's automatic (speech recognition) captions when the uploader did not provide any. Most videos only have these. Turn off to accept human-made captions only.", "default": true }, "includeTimestamps": { "title": "Timestamped segments", "type": "boolean", "description": "Add \"segments\": every caption line with its start time and duration in seconds. The full plain text is always included in \"text\".", "default": true }, "includeSrt": { "title": "SRT subtitles", "type": "boolean", "description": "Add the transcript as an SRT subtitle file in the \"srt\" field.", "default": false }, "includeMetadata": { "title": "Full video details", "type": "boolean", "description": "Add publish date, like count, category, description, tags and thumbnail. Title, channel, duration and views are always included.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "YouTube blocks many datacenter IP addresses. Residential proxies give each retry a fresh IP and are strongly recommended; proxy traffic is included in the price.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many times a blocked or failed request is retried (exponential backoff, new proxy IP each time) before the video is returned with status \"error\".", "default": 6 }, "maxConcurrency": { "title": "Parallel videos", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many videos are processed at the same time.", "default": 5 } } }, "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 } } } } } } } } } }