{ "openapi": "3.0.1", "info": { "title": "Video Frame Extractor (screenshots from video files)", "description": "Extract still images from video files at set times, every N seconds, or N evenly spaced frames. JPG, PNG or WebP, with resize. Direct links and uploads, MP4, WebM, MOV, MKV and more.", "version": "0.1", "x-build-id": "eymtVj7I2Tcc2wq56" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/psypherz~video-frame-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-psypherz-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/psypherz~video-frame-extractor/runs": { "post": { "operationId": "runs-sync-psypherz-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/psypherz~video-frame-extractor/run-sync": { "post": { "operationId": "run-sync-psypherz-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 links", "type": "array", "description": "Direct links to video files (MP4, WebM, MOV, MKV, AVI, OGV and more), one per line. Web pages and social or streaming sites (YouTube, TikTok, Instagram, Vimeo and similar) are not supported.", "items": { "type": "string" } }, "uploadedFile": { "title": "Or upload a video", "type": "string", "description": "Upload one video file from your computer." }, "mode": { "title": "Which frames", "enum": [ "interval", "count", "timestamps" ], "type": "string", "description": "How to pick frames from each video.", "default": "interval" }, "intervalSeconds": { "title": "Every N seconds", "minimum": 0.1, "maximum": 3600, "type": "number", "description": "Used by \"One frame every N seconds\". The first frame is at the start time.", "default": 10 }, "frameCount": { "title": "Number of frames", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Used by \"A set number of evenly spaced frames\". Each frame is taken from the middle of an equal slice of the video, so you avoid black first and last frames.", "default": 10 }, "timestamps": { "title": "Times", "type": "array", "description": "Used by \"Frames at exact times\". Seconds (90 or 90.5) or mm:ss / hh:mm:ss (1:30, 01:02:03.5). Times past the end of a video are skipped.", "items": { "type": "string" } }, "startTime": { "title": "Start time", "type": "string", "description": "Optional. Ignore the video before this time. Seconds or mm:ss." }, "endTime": { "title": "End time", "type": "string", "description": "Optional. Ignore the video after this time. Seconds or mm:ss." }, "maxFramesPerVideo": { "title": "Max frames per video", "minimum": 1, "maximum": 1000, "type": "integer", "description": "A safety cap on frames from each video. You only pay for frames saved.", "default": 100 }, "imageFormat": { "title": "Image format", "enum": [ "jpg", "png", "webp" ], "type": "string", "description": "File type of the saved frames.", "default": "jpg" }, "quality": { "title": "Quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "JPG and WebP quality from 1 to 100. Ignored for PNG.", "default": 85 }, "maxWidth": { "title": "Max width (pixels)", "minimum": 0, "maximum": 7680, "type": "integer", "description": "Shrink frames wider than this, keeping the shape. 0 keeps the original size.", "default": 0 }, "maxFileMb": { "title": "Max video size (MB)", "minimum": 1, "maximum": 4000, "type": "integer", "description": "Larger videos are skipped and not charged. Each 1 MB of limit needs 2 MB of run memory (the default 1 GB memory allows up to 512 MB videos).", "default": 500 }, "keyPrefix": { "title": "Storage key prefix", "type": "string", "description": "Optional text added to the start of every saved image's key, for example \"product-demo-\"." } } }, "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 } } } } } } } } } }