{ "openapi": "3.0.1", "info": { "title": "Video Frame Extractor: Extract Frames from Video URLs", "version": "0.1", "x-build-id": "OHHlalmaG6xaMcBuL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/venture_ace~video-frame-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-venture_ace-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/venture_ace~video-frame-extractor/runs": { "post": { "operationId": "runs-sync-venture_ace-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/venture_ace~video-frame-extractor/run-sync": { "post": { "operationId": "run-sync-venture_ace-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", "required": [ "videoUrls" ], "properties": { "videoUrls": { "title": "Video file URLs", "type": "array", "description": "Direct links to video files (mp4, webm, mov, mkv and anything ffmpeg reads), one per line, up to 20 per run. Page links (YouTube, TikTok, Instagram and similar) are refused with a per-video error. Localhost and private addresses are refused. Max 500 MB per file.", "items": { "type": "string" } }, "mode": { "title": "Extraction mode", "enum": [ "interval", "everyNth", "sceneChange", "timestamps" ], "type": "string", "description": "interval: one frame every N seconds. everyNth: every Nth video frame. sceneChange: the first frame plus a frame at each cut. timestamps: exact times you list.", "default": "interval" }, "intervalSeconds": { "title": "Seconds between frames (interval mode)", "minimum": 0.1, "maximum": 3600, "type": "number", "description": "One frame every this many seconds, starting at 0.", "default": 5 }, "everyNthFrame": { "title": "Frame step (everyNth mode)", "minimum": 1, "type": "integer", "description": "Keep every Nth decoded frame, starting with the first.", "default": 30 }, "sceneThreshold": { "title": "Scene change threshold (sceneChange mode)", "minimum": 0.05, "maximum": 0.95, "type": "number", "description": "0.05 to 0.95. Lower finds more cuts (0.3 is a good start for most video).", "default": 0.3 }, "timestamps": { "title": "Timestamps (timestamps mode)", "type": "array", "description": "Seconds (12.5) or clock time (1:30, 00:01:30.5), one per line. A time past the end of the video is skipped with a note.", "default": [], "items": { "type": "string" } }, "imageFormat": { "title": "Image format", "enum": [ "jpg", "png" ], "type": "string", "description": "jpg is smaller; png is lossless and much larger.", "default": "jpg" }, "maxWidth": { "title": "Max frame width (pixels)", "minimum": 64, "maximum": 4096, "type": "integer", "description": "Frames wider than this are scaled down, keeping the aspect ratio. Frames are never scaled up.", "default": 1280 }, "jpegQuality": { "title": "JPG quality", "minimum": 10, "maximum": 100, "type": "integer", "description": "10 to 100 (jpg only).", "default": 85 }, "maxFramesPerVideo": { "title": "Max frames per video", "minimum": 1, "maximum": 500, "type": "integer", "description": "Safety cap per video. Extraction stops there and the last row notes it.", "default": 50 }, "maxFramesTotal": { "title": "Max frames per run", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Safety cap on all frames in this run (and so on what the run can charge). Videos after it are returned with status skipped.", "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 } } } } } } } } } }