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
Crop a region out of a video.

Crop Video

Crop a rectangular region out of a video by specifying the region's size and position.

API Endpoint

POST /api/v1/tools/crop-video

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

Parameters

Parameter	Type	Required	Default	Description
width	integer	Yes	-	Crop region width in pixels (minimum 16)
height	integer	Yes	-	Crop region height in pixels (minimum 16)
x	integer	No	`0`	Horizontal offset from the top-left corner
y	integer	No	`0`	Vertical offset from the top-left corner

Example Request

curl -X POST http://localhost:1349/api/v1/tools/crop-video \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@clip.mp4" \
  -F 'settings={"width": 640, "height": 480, "x": 100, "y": 50}'

Example Response

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

Notes

The crop region must fit within the video dimensions. If x + width or y + height exceeds the source size, the request returns a 400 error.
Minimum crop size is 16x16 pixels.
Dimensions are rounded to even numbers as required by most video codecs.

1.4 KiB Raw Blame History