{ "openapi": "3.0.1", "info": { "title": "Video Frame Extractor: Scenes, Keyframes & On-Screen Text", "description": "🎞️ Turn any video file into still frames: one per scene (shots and slides, with fades, blank frames and repeats skipped), every N seconds, N evenly spaced or at exact times. Images ready for AI vision, a contact sheet, and optional OCR of on-screen text. Pay per frame.", "version": "0.1", "x-build-id": "3CFkR4CXNmvZTeQhi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yodeling_november~video-frame-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yodeling_november-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/yodeling_november~video-frame-extractor/runs": { "post": { "operationId": "runs-sync-yodeling_november-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/yodeling_november~video-frame-extractor/run-sync": { "post": { "operationId": "run-sync-yodeling_november-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", "type": "array", "description": "Direct links to video files: MP4, MOV, WebM, MKV, AVI, M4V, MPEG-TS and more (anything ffmpeg reads). Links to video pages (YouTube, TikTok, Instagram, Vimeo...) are not video files and are not supported.", "items": { "type": "string" } }, "files": { "title": "Upload videos", "type": "array", "description": "Or upload video files from your computer. They are stored in one of your key-value stores and read from there." }, "mode": { "title": "Which frames", "enum": [ "scenes", "interval", "count", "timestamps" ], "type": "string", "description": "One per scene: one frame for every shot, slide or new view, with fades, blank frames and repeats skipped. Every N seconds, N frames evenly spaced, or at the exact times you list.", "default": "scenes" }, "sceneSensitivity": { "title": "Scene sensitivity", "enum": [ "low", "medium", "high" ], "type": "string", "description": "With 'One per scene'. Medium finds every cut and every new slide. Low keeps only clear changes of picture. High also catches small changes, such as one more bullet on a slide.", "default": "medium" }, "framePosition": { "title": "Frame from each scene", "enum": [ "start", "middle", "end" ], "type": "string", "description": "With 'One per scene': the stillest frame near the start, the middle or the end of each scene. For slides that build up bullet by bullet, 'End' shows the finished slide.", "default": "middle" }, "intervalSeconds": { "title": "Every N seconds", "minimum": 0.1, "maximum": 86400, "type": "number", "description": "With 'Every N seconds': time between frames. Decimals work (0.5 is two frames a second).", "default": 10 }, "frameCount": { "title": "Number of frames", "minimum": 1, "maximum": 1000, "type": "integer", "description": "With 'N frames evenly spaced': how many frames across the video (or across the time range below).", "default": 10 }, "timestamps": { "title": "Timestamps", "type": "array", "description": "With 'At exact times': times in seconds (90 or 90.5) or as mm:ss / hh:mm:ss (1:30, 1:02:03.5).", "items": { "type": "string" } }, "startTime": { "title": "Start time", "type": "string", "description": "Only use the video from this time (seconds or mm:ss). Empty: from the beginning." }, "endTime": { "title": "End time", "type": "string", "description": "Only use the video up to this time (seconds or mm:ss). Empty: to the end." }, "maxFramesPerVideo": { "title": "Max frames per video", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Upper limit of frames returned for one video. With 'One per scene', the longest scenes are kept.", "default": 100 }, "skipDuplicates": { "title": "Skip near-identical frames", "type": "boolean", "description": "Leave out a frame when it looks the same as one already returned (a static shot, a slide shown twice, a shot that comes back). You are not charged for skipped frames. Not used with 'At exact times'.", "default": true }, "skipBlankFrames": { "title": "Skip blank frames", "type": "boolean", "description": "Leave out black, white and single-colour frames (fades, leaders). 'One per scene' always skips them; 'At exact times' never does.", "default": true }, "imageFormat": { "title": "Image format", "enum": [ "jpg", "webp", "png" ], "type": "string", "description": "JPEG is small and works everywhere, WebP is smaller still, PNG is lossless (and large).", "default": "jpg" }, "maxImageSize": { "title": "Max image size (px)", "minimum": 0, "maximum": 7680, "type": "integer", "description": "Longest side of the saved images; the aspect ratio is kept. 1280 suits AI vision models. 0 keeps the video's own size.", "default": 1280 }, "imageQuality": { "title": "Image quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "JPEG and WebP quality, from 1 to 100.", "default": 85 }, "contactSheet": { "title": "Contact sheet", "type": "boolean", "description": "Also save one image with all the frames of each video in a grid, with their time codes (up to 100 frames). Free.", "default": true }, "ocr": { "title": "Read on-screen text (OCR)", "type": "boolean", "description": "Read the text in each frame (slides, titles, captions, labels) into the 'text' field. Billed per frame as 'OCR frame'.", "default": false }, "ocrLanguages": { "title": "OCR languages", "type": "array", "description": "Languages of the text on screen. Pick only the ones you need: each extra language makes OCR slower.", "items": { "type": "string", "enum": [ "eng", "por", "spa", "fra", "deu", "ita", "nld", "pol", "ces", "slk", "slv", "hrv", "ron", "hun", "swe", "dan", "nor", "fin", "est", "lav", "lit", "ell", "tur", "rus", "ukr", "bul", "cat" ], "enumTitles": [ "English", "Portuguese", "Spanish", "French", "German", "Italian", "Dutch", "Polish", "Czech", "Slovak", "Slovenian", "Croatian", "Romanian", "Hungarian", "Swedish", "Danish", "Norwegian", "Finnish", "Estonian", "Latvian", "Lithuanian", "Greek", "Turkish", "Russian", "Ukrainian", "Bulgarian", "Catalan" ] }, "default": [ "eng" ] }, "maxVideoSizeMb": { "title": "Max video size (MB)", "minimum": 1, "maximum": 8192, "type": "integer", "description": "Larger videos are skipped and reported as failed rows (not charged).", "default": 1024 }, "timeoutPerVideoSecs": { "title": "Timeout per video (seconds)", "minimum": 60, "maximum": 7200, "type": "integer", "description": "A video that takes longer returns the frames found so far, marked 'partial'.", "default": 1800 } } }, "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 } } } } } } } } } }