{ "openapi": "3.0.1", "info": { "title": "YouTube, TikTok & Reels Transcript — Video to Text + Hooks", "description": "Turn YouTube, Shorts, TikTok and Instagram Reels URLs into text: timecoded transcript sentences, full transcript, the opening hook typed and scored, on-screen text, keywords, hashtags and chapters. Captions first, Whisper when there are none. Batch input, pay per result.", "version": "1.0", "x-build-id": "fbbUXO9nPieJzH0c0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ntriqpro~video-transcript-hooks/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ntriqpro-video-transcript-hooks", "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/ntriqpro~video-transcript-hooks/runs": { "post": { "operationId": "runs-sync-ntriqpro-video-transcript-hooks", "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/ntriqpro~video-transcript-hooks/run-sync": { "post": { "operationId": "run-sync-ntriqpro-video-transcript-hooks", "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", "type": "array", "description": "One per line, up to 200: YouTube videos and Shorts, TikTok videos and Instagram Reels (public, no login). Duplicates are processed once. Only submit videos you have the right to process; you are responsible for how you use the output and for each platform's terms.", "items": { "type": "string" } }, "layers": { "title": "Layers", "type": "array", "description": "Which rows to produce for each video. Leave empty for all. The video metadata row is always delivered.", "items": { "type": "string", "enum": [ "transcriptSegments", "transcriptFull", "hook", "onscreenText", "keywords", "chapters" ], "enumTitles": [ "Timecoded transcript sentences (transcript-segment)", "Full transcript (transcript-full)", "Hook: first N seconds, typed and scored (hook-extracted)", "On-screen text from frames (onscreen-text)", "Keywords and hashtags (keywords-hashtags)", "Chapters (chapter-detected)" ] } }, "language": { "title": "Language", "type": "string", "description": "auto detects the spoken language. Or give a two-letter code (en, es, ko, ...) to pick that caption track or force Whisper to that language." }, "hookSeconds": { "title": "Hook window (seconds)", "minimum": 1, "maximum": 15, "type": "integer", "description": "How many opening seconds count as the hook. Sentences that start inside the window are kept whole." }, "whisperModel": { "title": "Speech-to-text model (when a video has no captions)", "enum": [ "base", "tiny" ], "type": "string", "description": "base is more accurate, tiny is faster. Both are built into the image (no download wait)." }, "ocrMaxVideoSeconds": { "title": "On-screen text: longest video to scan (seconds)", "minimum": 10, "maximum": 1800, "type": "integer", "description": "On-screen text is read from one frame every 2 seconds (English OCR). Videos longer than this skip that layer; everything else is still delivered." }, "timeoutPerVideo": { "title": "Time limit per video (seconds)", "minimum": 60, "maximum": 1800, "type": "integer", "description": "Transcription stops after this many seconds per video; the transcript delivered so far is marked truncated." }, "proxyConfiguration": { "title": "Proxy (fallback only)", "type": "object", "description": "Each video is first fetched directly. The proxy is used only when a platform refuses the direct request (YouTube often blocks cloud IPs)." } } }, "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 } } } } } } } } } }