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.4 KiB

Raw Blame History

description

description
Shrink video file size with quality control.

Compress Video

Shrink video file size using configurable compression strength and optional resolution downscaling.

API Endpoint

POST /api/v1/tools/compress-video

Accepts multipart form data with a video file and a JSON settings field. This is an async endpoint - it returns 202 Accepted immediately and progress is streamed via SSE at GET /api/v1/jobs/{jobId}/progress.

Parameters

Parameter	Type	Required	Default	Description
quality	string	No	`"balanced"`	Compression strength: `light`, `balanced`, `strong`
resolution	string	No	`"original"`	Output resolution: `original`, `1080p`, `720p`, `480p`

Example Request

curl -X POST http://localhost:1349/api/v1/tools/compress-video \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@clip.mp4" \
  -F 'settings={"quality": "strong", "resolution": "720p"}'

Example Response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "async": true
}

Notes

The light preset preserves near-original quality. The strong preset reduces file size aggressively at the cost of visual fidelity.
Downscaling resolution (e.g. from 4K to 720p) compounds with compression for significant size reduction.
Progress updates are available via SSE at GET /api/v1/jobs/{jobId}/progress until the job completes.

1.4 KiB Raw Blame History