{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Extractor - Bulk Captions & Subtitles API", "description": "Extract YouTube transcripts in bulk. Timestamped segments, plain text, SRT and VTT from any video URL or ID. Auto and manual captions, 100+ languages. Pay only for successful transcripts.", "version": "1.0", "x-build-id": "2VV7gLRgnNXf83xUg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apricot_blackberry~youtube-transcript-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apricot_blackberry-youtube-transcript-extractor", "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/apricot_blackberry~youtube-transcript-extractor/runs": { "post": { "operationId": "runs-sync-apricot_blackberry-youtube-transcript-extractor", "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/apricot_blackberry~youtube-transcript-extractor/run-sync": { "post": { "operationId": "run-sync-apricot_blackberry-youtube-transcript-extractor", "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", "type": "array", "description": "YouTube video URLs (watch, youtu.be, Shorts, live, embed) or bare 11-character video IDs. One transcript per video.", "items": { "type": "string" } }, "language": { "title": "Preferred language", "type": "string", "description": "ISO language code to prefer (e.g. en, es, de, pt, ja). Manual captions in this language win over auto-generated ones.", "default": "en" }, "fallbackToAutoCaptions": { "title": "Fall back to auto-generated captions", "type": "boolean", "description": "Use YouTube's auto-generated captions when no manual captions exist in the preferred language.", "default": true }, "fallbackToAnyLanguage": { "title": "Fall back to any language", "type": "boolean", "description": "If nothing matches the preferred language, take the first available caption track instead of failing the video.", "default": true }, "formats": { "title": "Extra output formats", "type": "array", "description": "Plain text and timestamped segments are always included. Optionally add subtitle file formats.", "items": { "type": "string", "enum": [ "srt", "vtt" ], "enumTitles": [ "SRT subtitles", "WebVTT subtitles" ] }, "default": [] }, "includeSegments": { "title": "Include timestamped segments", "type": "boolean", "description": "Include the segments array (start, duration, text). Turn off for smaller items when you only need plain text.", "default": true }, "residentialFallback": { "title": "Residential proxy fallback", "type": "boolean", "description": "Escalate to residential proxies ONLY for videos that fail via both direct connection and the standard proxy. Residential traffic is billed to your Apify account per GB (transcripts are small, typically well under 1 MB per video). Disable to never incur residential costs.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Standard proxy used from the second attempt per video (the first attempt connects directly, which is free). Datacenter by default - included in Apify plans. Residential escalation is controlled separately by 'Residential proxy fallback'.", "default": { "useApifyProxy": 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 } } }, "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 } } } } } } } } } }