{ "openapi": "3.0.1", "info": { "title": "YouTube Transcript Scraper", "description": "Extract YouTube transcripts from videos, playlists, channels or search queries. Works when other transcript scrapers return nothing. Five output formats, 100+ languages, YouTube translation.", "version": "0.1", "x-build-id": "mbIHd7mezQpPmlz3l" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammad4hmed~youtube-transcript-ai/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammad4hmed-youtube-transcript-ai", "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/muhammad4hmed~youtube-transcript-ai/runs": { "post": { "operationId": "runs-sync-muhammad4hmed-youtube-transcript-ai", "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/muhammad4hmed~youtube-transcript-ai/run-sync": { "post": { "operationId": "run-sync-muhammad4hmed-youtube-transcript-ai", "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": "Videos, playlists, channels or searches", "type": "array", "description": "Accepts video URLs or IDs, playlist URLs, channel URLs and @handles, and search terms written as `search:your query`.", "items": { "type": "string" } }, "languages": { "title": "Preferred caption languages", "type": "array", "description": "Language codes in priority order. The first available match wins.", "default": [ "en" ], "items": { "type": "string" } }, "fallbackToAnyLanguage": { "title": "Fall back to any available language", "type": "boolean", "description": "If none of the preferred languages exist, use whatever caption track the video has.", "default": true }, "preferManualCaptions": { "title": "Prefer human-written captions", "type": "boolean", "description": "Within the same language, prefer manually written captions over auto-generated ones.", "default": true }, "translateTo": { "title": "Translate transcript to", "type": "string", "description": "Optional language code (e.g. `es`, `de`). Uses YouTube's own caption translation." }, "outputFormat": { "title": "Transcript format", "enum": [ "text", "segments", "srt", "vtt", "markdown" ], "type": "string", "description": "Shape of the `transcript` field in each result.", "default": "text" }, "maxVideos": { "title": "Maximum videos", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on how many videos are processed. Protects you from an accidental whole-channel run.", "default": 100 }, "aiEnrichments": { "title": "AI enrichments", "type": "array", "description": "Optional AI analysis of each transcript. Requires the Actor operator to configure an LLM credential; if none is set the run returns transcripts only and logs a warning — it never fails.", "items": { "type": "string", "enum": [ "summary", "keyPoints", "chapters" ], "enumTitles": [ "Summary", "Key points", "Chapters" ] }, "default": [] }, "aiInstructions": { "title": "Custom AI instructions", "type": "string", "description": "Optional extra guidance for the AI, e.g. \"focus on pricing and product claims\"." }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many videos to fetch in parallel. Lower this if you hit rate limits.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy is REQUIRED. YouTube blocks datacenter IPs with \"Sign in to confirm you're not a bot\", so runs without a residential proxy will mostly fail.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }