{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper: Channels, Playlists & SRT", "description": "YouTube transcripts with timestamps from videos, whole channels or playlists, in the languages you pick. $1 per 1,000 transcripts. SRT and VTT files, word times, every caption language listed.", "version": "0.1", "x-build-id": "z7HcGqqQE9rrpJPLr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/luzivanlt~youtube-transcripts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-luzivanlt-youtube-transcripts-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/luzivanlt~youtube-transcripts-scraper/runs": { "post": { "operationId": "runs-sync-luzivanlt-youtube-transcripts-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/luzivanlt~youtube-transcripts-scraper/run-sync": { "post": { "operationId": "run-sync-luzivanlt-youtube-transcripts-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": { "startUrls": { "title": "Video, channel or playlist links", "type": "array", "description": "YouTube videos (watch, youtu.be, Shorts, live and embed links, or 11-character video ids), channels (@handle, /channel/UC…, /c/ and /user/ links, or a bare @handle or UC… id) and playlists (a playlist link or its PL… id). A channel gives its newest uploads, a playlist its videos in order, up to Max videos per channel or playlist. Required unless you give a dataset id or rows below. Example: https://www.youtube.com/watch?v=dQw4w9WgXcQ", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "datasetId": { "title": "Dataset id from a scraper run", "type": "string", "description": "The id of a run's dataset from YouTube Scraper (streamers/youtube-scraper), so you do not copy video links by hand. Every row's url is read as a video link (videoUrl and video_url too); rows without one are skipped and counted in the status. Reads up to 10,000 rows. Our YouTube Search and YouTube Channel Videos Actors also work. Example: your scraper run's dataset id, e.g. from its Storage tab (a username~name or a dataset link works too)." }, "datasetRows": { "title": "Rows from a scraper run", "type": "array", "description": "Rows pasted from YouTube Scraper (streamers/youtube-scraper) results, as a JSON list, when its dataset id is not readable by your account. Each row's url is read as a video link (videoUrl and video_url too); rows without one are skipped. Reads up to 10,000 rows. Example: [{\"url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\"}]" }, "languages": { "title": "Languages", "type": "array", "description": "Caption languages you want, in order of preference, as codes such as en, es or pt-BR (up to 20). The first one a video has is used, matched exactly first and then by its base language (es also takes es-419). Leave empty for the language spoken in the video. A video with none of them falls back to its spoken language, and its row says so in language_found. Example: [\"es\", \"en\"]", "items": { "type": "string" } }, "captionType": { "title": "Caption type", "enum": [ "any", "manual", "auto" ], "type": "string", "description": "Which captions to use: any (captions written by people first, else auto-generated), manual (only captions written by people) or auto (only auto-generated). A video without the kind asked for is skipped and not charged. Default any. Example: \"manual\" for subtitles uploaded by the channel only.", "default": "any" }, "subtitleFormats": { "title": "Subtitle files", "type": "array", "description": "Also return the transcript as subtitle file text, ready to save as a .srt or .vtt file, in the srt and vtt fields. No extra charge. Leave empty for the timed lines and plain text only. Example: [\"srt\"] to get an SRT file's text on every row.", "items": { "type": "string", "enum": [ "srt", "vtt" ], "enumTitles": [ "SRT", "WebVTT" ] }, "default": [] }, "wordTimestamps": { "title": "Word timestamps", "type": "boolean", "description": "Also list each word with its start time inside each timed line, where YouTube times words (auto-generated captions). No extra charge, but rows get larger. Off by default. Captions written by people have one time per line and no word times, so their lines carry no word list.", "default": false }, "maxVideosPerChannel": { "title": "Max videos per channel or playlist", "minimum": 1, "maximum": 10000, "type": "integer", "description": "For each channel or playlist link, read this many of its videos: a channel's newest uploads first, a playlist in its own order. Default 10, from 1 to 10,000. Videos without captions are skipped and not charged, so you may get fewer transcripts than this. Video links are not affected.", "default": 10 } } }, "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 } } } } } } } } } }