{ "openapi": "3.0.1", "info": { "title": "Video Frame Extractor — Video to Images, Scenes & Thumbnails", "description": "Turn video files into still images: auto storyboard, every N seconds, N evenly spaced, scene changes, keyframes or set times. Skips blank frames, makes contact sheets. MP4, MOV, WebM, MKV in; JPEG, PNG or WebP out. Part of NexGen Signal — data tools and official-source data products", "version": "0.1", "x-build-id": "lI4YDaoLdmAMcCfuO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgensignal~video-frame-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgensignal-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/nexgensignal~video-frame-extractor/runs": { "post": { "operationId": "runs-sync-nexgensignal-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/nexgensignal~video-frame-extractor/run-sync": { "post": { "operationId": "run-sync-nexgensignal-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 file links", "type": "array", "description": "Direct links to video files (not YouTube or social media pages). Up to 500 per run.", "items": { "type": "string" } }, "mode": { "title": "How to pick frames", "enum": [ "auto", "interval", "count", "scenes", "keyframes", "timestamps" ], "type": "string", "description": "Auto gives frameCount frames that cover the whole video: the start, the strongest cut in each part of it, then evenly spaced frames if there are not enough cuts. Scene changes and keyframes are found by reading the video; the others are planned from its length.", "default": "interval" }, "intervalSeconds": { "title": "Every N seconds", "minimum": 0.04, "maximum": 86400, "type": "number", "description": "For 'every N seconds'. 1 = one frame per second; 0.5 = two per second.", "default": 10 }, "frameCount": { "title": "Number of frames", "minimum": 1, "maximum": 10000, "type": "integer", "description": "For 'auto' and 'evenly spaced': how many frames per video (evenly spaced with 1 = the middle frame).", "default": 10 }, "sceneThreshold": { "title": "Scene change sensitivity", "minimum": 0.01, "maximum": 1, "type": "number", "description": "For 'scene changes': lower finds more cuts (0.2 sensitive, 0.4 strict).", "default": 0.3 }, "sceneMinGapSeconds": { "title": "Minimum gap between scenes (s)", "minimum": 0, "maximum": 3600, "type": "number", "description": "For 'scene changes': cuts closer than this are merged (the strongest one is kept), so flashes do not flood the results.", "default": 1 }, "timestamps": { "title": "Times", "type": "array", "description": "For 'times I list': seconds (12.5), HH:MM:SS (00:01:30.5) or 1m30s.", "default": [], "items": { "type": "string" } }, "startSeconds": { "title": "Start at (s)", "minimum": 0, "maximum": 86400, "type": "number", "description": "Only take frames from this time on.", "default": 0 }, "endSeconds": { "title": "End at (s)", "minimum": 0, "maximum": 86400, "type": "number", "description": "Only take frames before this time. 0 = to the end.", "default": 0 }, "imageFormat": { "title": "Image format", "enum": [ "jpg", "png", "webp" ], "type": "string", "description": "JPEG is smallest for photos, PNG is lossless.", "default": "jpg" }, "quality": { "title": "Quality (JPEG / WebP)", "minimum": 1, "maximum": 100, "type": "integer", "description": "1–100. Ignored for PNG.", "default": 90 }, "maxWidth": { "title": "Maximum width (px)", "minimum": 0, "maximum": 8192, "type": "integer", "description": "Shrink wider frames to this width, keeping the shape. 0 = full size.", "default": 0 }, "maxHeight": { "title": "Maximum height (px)", "minimum": 0, "maximum": 8192, "type": "integer", "description": "Shrink taller frames to this height, keeping the shape. 0 = full size.", "default": 0 }, "skipBlankFrames": { "title": "Skip blank frames", "type": "boolean", "description": "When a chosen frame is black, white or one flat colour (a fade, a black intro), step forward up to 2 seconds to the first frame with content.", "default": true }, "contactSheet": { "title": "Contact sheet", "type": "boolean", "description": "Also save one grid image per video with up to 100 frames and their timecodes (free, link in every row).", "default": false }, "saveFrames": { "title": "Save image files", "type": "boolean", "description": "Store each frame in the run's key-value store with a download link. Off = details only.", "default": true }, "maxFramesPerVideo": { "title": "Frames per video", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Most frames taken from one video.", "default": 500 }, "maxVideoMb": { "title": "Largest video (MB)", "minimum": 1, "maximum": 4000, "type": "integer", "description": "Skip video files bigger than this.", "default": 1000 }, "maxFrames": { "title": "Maximum frames", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many frames are delivered. Each delivered frame is billed; videos that cannot be read are not.", "default": 1000 } } }, "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 } } } } } } } } } }