{ "openapi": "3.0.1", "info": { "title": "Video Frame Extractor – Thumbnails, Scenes & Keyframes", "description": "Extract still frames from any video file URL (MP4, MOV, WebM, MKV, HLS): one frame every N seconds, N thumbnails, exact timestamps, scene changes or keyframes. JPEG/PNG/WebP links, timecodes, contact sheet and video metadata. Ready for AI vision. $1 per 1,000 frames.", "version": "0.1", "x-build-id": "fjb7BJSIMPsNs0xRU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gazidev~video-frame-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gazidev-video-frame-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/gazidev~video-frame-extractor/runs": { "post": { "operationId": "runs-sync-gazidev-video-frame-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/gazidev~video-frame-extractor/run-sync": { "post": { "operationId": "run-sync-gazidev-video-frame-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", "properties": { "videoUrls": { "title": "Video URLs (direct file links)", "type": "array", "description": "Direct links to video files: MP4, MOV, WebM, MKV, AVI, M4V, TS, or HLS `.m3u8` playlists (your CDN, S3/R2 bucket, Dropbox direct link…). Pages of YouTube, TikTok, Instagram, Vimeo etc. are not supported.", "items": { "type": "string" } }, "bulkText": { "title": "Bulk list (paste text or CSV)", "type": "string", "description": "One URL per line or a CSV with a `url` column." }, "datasetId": { "title": "Read URLs from an Apify dataset (ID or name)", "type": "string", "description": "Chain after another Actor." }, "datasetField": { "title": "Dataset field with the video URL", "type": "string", "description": "Field name in that dataset.", "default": "url" }, "mode": { "title": "What to extract", "enum": [ "interval", "count", "timestamps", "scenes", "keyframes" ], "type": "string", "description": "`interval` and `count` seek directly to each timestamp (fast even on hour-long videos). `scenes` and `keyframes` scan the video and are billed per minute scanned.", "default": "interval" }, "intervalSec": { "title": "Interval (seconds)", "minimum": 0.04, "type": "number", "description": "For `interval` mode, e.g. 1 for one frame per second.", "default": 10 }, "frameCount": { "title": "Number of thumbnails", "minimum": 1, "maximum": 1000, "type": "integer", "description": "For `count` mode: frames spread evenly over the video (or the start–end range).", "default": 10 }, "timestamps": { "title": "Timestamps", "type": "array", "description": "For `timestamps` mode: seconds (`90`, `12.5`) or `HH:MM:SS(.ms)` / `MM:SS`.", "items": { "type": "string" } }, "sceneThreshold": { "title": "Scene-change sensitivity", "minimum": 0.01, "maximum": 0.99, "type": "number", "description": "For `scenes` mode: lower = more frames (0.2 sensitive, 0.4 only hard cuts).", "default": 0.3 }, "accurateScenes": { "title": "Accurate scene detection (decode every frame)", "type": "boolean", "description": "Off = compare keyframes only (fast, may miss cuts between keyframes). On = frame-exact cuts, slower. Same price.", "default": false }, "startTime": { "title": "Start at", "type": "string", "description": "Optional, e.g. `00:01:00`." }, "endTime": { "title": "End at", "type": "string", "description": "Optional, e.g. `00:05:00`." }, "maxFramesPerVideo": { "title": "Max frames per video", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap per video.", "default": 100 }, "skipBlackFrames": { "title": "Skip black frames", "type": "boolean", "description": "Fades and black screens are dropped and not charged.", "default": true }, "imageFormat": { "title": "Image format", "enum": [ "jpg", "png", "webp" ], "type": "string", "description": "Output format of the frame images.", "default": "jpg" }, "quality": { "title": "Quality (JPEG/WebP)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Higher = sharper and bigger files.", "default": 85 }, "maxWidth": { "title": "Max width (px)", "minimum": 64, "maximum": 3840, "type": "integer", "description": "Frames wider than this are downscaled (aspect ratio kept). Never upscaled.", "default": 1280 }, "contactSheet": { "title": "Contact sheet per video", "type": "boolean", "description": "One overview image with up to 48 frames and their timecodes. Free.", "default": true }, "maxScanMinutes": { "title": "Max minutes to scan (scenes / keyframes)", "minimum": 1, "maximum": 600, "type": "integer", "description": "Cost cap for scanning modes: longer videos are scanned only up to this length.", "default": 60 }, "maxDurationMinutes": { "title": "Max minutes per video", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Safety limit: only this many minutes of each video (from `startTime`) are processed, so a huge file or endless stream cannot run for hours. 0 = no limit. The run also stops ~30 s before its timeout and keeps everything saved so far.", "default": 240 }, "maxConcurrency": { "title": "Videos in parallel", "minimum": 1, "maximum": 8, "type": "integer", "description": "Each video also uses up to 4 parallel seeks.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Only for hosts that block datacenter IPs (HTTP 403).", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }