{ "openapi": "3.0.1", "info": { "title": "Smart Video Keyframes: Best Frame per Scene for AI", "description": "Turn videos into a clean set of keyframes: one sharp frame per scene, with blurry and duplicate shots removed. Timestamps, contact sheet and optional on-screen text. Ready for vision LLMs, RAG and thumbnails. Pay per video minute and frame.", "version": "1.0", "x-build-id": "IbB6XWXmrh8f5grIK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nookforgestudio~video-keyframe-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nookforgestudio-video-keyframe-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/nookforgestudio~video-keyframe-extractor/runs": { "post": { "operationId": "runs-sync-nookforgestudio-video-keyframe-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/nookforgestudio~video-keyframe-extractor/run-sync": { "post": { "operationId": "run-sync-nookforgestudio-video-keyframe-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": { "urls": { "title": "Video URLs", "type": "array", "description": "Direct links to video files (MP4, MOV, WebM, MKV, AVI and most other formats). Page links such as YouTube or TikTok are not supported; use a downloader Actor first and pass its file links or dataset.", "items": { "type": "string" } }, "datasetId": { "title": "Read video URLs from a dataset", "type": "string", "description": "Optional. ID of an Apify dataset (for example a downloader or scraper output) that contains video file URLs." }, "urlField": { "title": "URL field in dataset", "type": "string", "description": "Dot path to the field holding the video URL(s), e.g. 'videoUrl' or 'media.url'. Arrays are expanded.", "default": "url" }, "mode": { "title": "How to pick frames", "enum": [ "scenes", "interval", "count" ], "type": "string", "description": "'Scenes': the sharpest frame of each shot. 'Interval': the sharpest frame in every N-second window. 'Count': a fixed number of evenly spread frames.", "default": "scenes" }, "sceneSensitivity": { "title": "Scene sensitivity", "enum": [ "low", "normal", "high" ], "type": "string", "description": "Higher finds more, subtler cuts (slides, slow pans). Lower only splits on hard cuts.", "default": "normal" }, "intervalSeconds": { "title": "Interval (seconds)", "minimum": 1, "maximum": 3600, "type": "integer", "description": "Used with 'Every N seconds'.", "default": 10 }, "frameCount": { "title": "Number of frames", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Used with 'Fixed number of frames'.", "default": 12 }, "maxFramesPerVideo": { "title": "Max frames per video", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Caps frames and cost per video. When a video has more scenes, the longest scenes are kept.", "default": 50 }, "skipBlurry": { "title": "Skip blurry frames", "type": "boolean", "description": "Drop picks that are much softer than the video's typical sharpness (motion blur, focus pulls, transitions).", "default": true }, "skipDuplicates": { "title": "Skip duplicate frames", "type": "boolean", "description": "Drop frames that look nearly identical to one already kept, such as a shot the video cuts back to.", "default": true }, "extractText": { "title": "Read on-screen text", "type": "boolean", "description": "Run OCR on every kept frame and return its text (slides, captions, signs, UI). Charged per frame.", "default": false }, "contactSheet": { "title": "Contact sheet", "type": "boolean", "description": "Save one overview image per video with all keyframes and timecodes.", "default": true }, "imageFormat": { "title": "Image format", "enum": [ "jpg", "webp", "png" ], "type": "string", "description": "Format of saved frames.", "default": "jpg" }, "maxWidth": { "title": "Max frame width (px)", "minimum": 160, "maximum": 3840, "type": "integer", "description": "Frames wider than this are downscaled. Use 3840 to keep 4K.", "default": 1280 }, "quality": { "title": "JPEG / WebP quality", "minimum": 30, "maximum": 100, "type": "integer", "description": "30 to 100.", "default": 85 }, "minSceneSeconds": { "title": "Min scene length (seconds)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Cuts closer together than this are merged.", "default": 1 }, "maxVideoMinutes": { "title": "Max video length (minutes)", "minimum": 1, "maximum": 600, "type": "integer", "description": "Longer videos are skipped and not charged.", "default": 120 }, "maxVideoMB": { "title": "Max video file size (MB)", "minimum": 10, "maximum": 4000, "type": "integer", "description": "Larger files are skipped and not charged.", "default": 1500 }, "maxVideos": { "title": "Max videos", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Safety cap on videos per run.", "default": 100 } } }, "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 } } } } } } } } } }