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
Crop images by specifying a region with position and dimensions.

Crop

Crop images by defining a rectangular region using position and size. Supports both pixel and percentage units.

API Endpoint

POST /api/v1/tools/crop

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

Parameters

Parameter	Type	Required	Default	Description
left	number	Yes	-	X offset of the crop region (from left edge)
top	number	Yes	-	Y offset of the crop region (from top edge)
width	number	Yes	-	Width of the crop region
height	number	Yes	-	Height of the crop region
unit	string	No	`"px"`	Unit for the values: `px` or `percent`

Example Request

curl -X POST http://localhost:1349/api/v1/tools/crop \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@photo.jpg" \
  -F 'settings={"left": 100, "top": 50, "width": 800, "height": 600}'

Crop using percentage values:

curl -X POST http://localhost:1349/api/v1/tools/crop \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@photo.jpg" \
  -F 'settings={"left": 10, "top": 10, "width": 80, "height": 80, "unit": "percent"}'

Example Response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/photo.jpg",
  "originalSize": 2450000,
  "processedSize": 1200000
}

Notes

The crop region must fit within the image boundaries. If the region extends beyond the image, the request will fail.
When using percent unit, values represent percentages of the image dimensions (e.g. left: 10 means 10% from the left edge).
Output format matches the input format.
EXIF orientation is auto-applied before cropping, so coordinates correspond to the visually correct orientation.

1.9 KiB Raw Blame History