{ "openapi": "3.0.1", "info": { "title": "Youtube Transcription Scraper", "description": "Get the full transcript of any YouTube video in seconds.Paste a video link, a list of links, or a whole YouTube playlist, and download clean transcripts, captions, and subtitles as TXT, SRT, or JSON. No YouTube API key. No quotas. No browser extensions. Works on single videos or thousands at a time.", "version": "0.1", "x-build-id": "Gfss9zYPtIcfN4cb1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hgservices~youtube-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hgservices-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/hgservices~youtube-transcript-scraper/runs": { "post": { "operationId": "runs-sync-hgservices-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/hgservices~youtube-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-hgservices-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": [ "urls" ], "properties": { "urls": { "title": "YouTube URLs", "type": "array", "description": "One or more YouTube video URLs, video IDs, or playlist URLs to fetch transcripts for. Mix and match — videos, IDs, playlists, all in the same run.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "format": { "title": "Output Format", "enum": [ "txt", "srt", "json" ], "type": "string", "description": "Format of the transcript output.", "default": "txt" }, "languages": { "title": "Preferred Languages", "type": "array", "description": "Language codes in priority order, e.g. ['en', 'es']. Leave empty to default to English (with fallback to the original language). Set this if you want a non-English transcript — e.g. ['es'] for a Spanish video.", "default": [], "items": { "type": "string" } }, "translate": { "title": "Translate To", "type": "string", "description": "Translate the transcript to this language code (e.g. 'en', 'es', 'fr'). Uses the best available source transcript.", "default": "" }, "preserveFormatting": { "title": "Preserve Formatting", "type": "boolean", "description": "Keep HTML formatting tags from the original transcript (e.g. , ).", "default": false }, "merge": { "title": "Merge Segments into Readable Paragraphs", "type": "boolean", "description": "Combine YouTube's choppy 2-second caption fragments into clean sentences and paragraphs — perfect for blog posts, summaries, and LLM prompts. Turn off if you need raw segment-level timing (e.g. for SRT subtitles).", "default": true }, "noTimestamps": { "title": "Omit Timestamps", "type": "boolean", "description": "Remove [MM:SS] timestamps from TXT output.", "default": false }, "includePlaylist": { "title": "Expand Playlists", "type": "boolean", "description": "If a playlist URL is provided, expand it to fetch transcripts for all videos in the playlist.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration (advanced)", "type": "object", "description": "Optional override. By default the actor auto-selects and escalates proxies (no proxy → datacenter → residential) on YouTube blocks, so most users can leave this alone. Setting a value here disables auto-escalation.", "default": {} } } }, "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 } } } } } } } } } }