mirror of https://github.com/snapotter-hq/SnapOtter.git synced 2026-08-03 07:46:42 +02:00

Files

T

SnapOtter 8532f3227b docs: audit all 157 tool pages against live schemas

Reconcile every tool page's parameters, defaults, and response shape against the tool's Zod settings schema and executionHint in code. Notable fixes: color-palette (add count + format params, hex output, median-cut algorithm), favicon (add 5 params, was documented as having none), qr-generate (add logoDataUri), convert (add ppm/eps/tga formats), video-loudnorm (-16 LUFS not -14), smart-crop (async 202 not sync 200), images-to-video (1080x1080 square), and several output-filename and behavior-note corrections.

Also normalize API endpoint paths to /api/v1/tools/<id> (no modality segment) and standardize curl examples on the Docker API port 1349. Verified with a clean docs build.

2026-06-18 14:12:28 +08:00

1.9 KiB

Raw Blame History

description

description
Extract frames from a video as a ZIP of images.

Video to Frames

Extract individual frames from a video and download them as a ZIP archive of PNG or JPG images.

API Endpoint

POST /api/v1/tools/video-to-frames

Accepts multipart form data with a video file and a JSON settings field.

Parameters

Parameter	Type	Required	Default	Description
mode	string	No	`"all"`	Extraction mode: `all`, `nth`, `timestamps`
n	integer	No	`10`	Extract every Nth frame (2-1000). Only used when mode is `"nth"`
timestamps	string	No	`""`	Comma-separated timestamps in seconds. Required when mode is `"timestamps"`
format	string	No	`"png"`	Image format for extracted frames: `png`, `jpg`

Example Request

Extract every 30th frame as JPG:

curl -X POST http://localhost:1349/api/v1/tools/video-to-frames \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@clip.mp4" \
  -F 'settings={"mode": "nth", "n": 30, "format": "jpg"}'

Extract frames at specific timestamps:

curl -X POST http://localhost:1349/api/v1/tools/video-to-frames \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@clip.mp4" \
  -F 'settings={"mode": "timestamps", "timestamps": "1.5,5,12.3"}'

Example Response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/clip-frames.zip",
  "originalSize": 12500000,
  "processedSize": 45000000
}

Notes

The all mode extracts every frame and can produce very large ZIP files for long videos. Use nth or timestamps mode for selective extraction.
PNG preserves full quality but produces larger files. JPG is smaller but lossy.
The response downloads as a ZIP archive containing sequentially numbered image files.

1.9 KiB Raw Blame History