mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtter
8532f3227b
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.
53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
---
|
|
description: Crop an image to a centered circle with transparent corners.
|
|
---
|
|
|
|
# Circle Crop
|
|
|
|
Crop an image to a centered circle with transparent corners. Supports adjustable zoom, offset, border, and output size.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/circle-crop`
|
|
|
|
Accepts multipart form data with an image file and a JSON `settings` field.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| zoom | number | No | `1` | Zoom factor (1-5); higher values crop tighter |
|
|
| offsetX | number | No | `0.5` | Horizontal center position (0-1) |
|
|
| offsetY | number | No | `0.5` | Vertical center position (0-1) |
|
|
| borderWidth | integer | No | `0` | Border width in pixels (0-200) |
|
|
| borderColor | string | No | `"#ffffff"` | Border hex color |
|
|
| background | string | No | `"transparent"` | Corner fill: `"transparent"` or a hex color |
|
|
| outputSize | integer | No | - | Final square dimension in pixels (16-4096) |
|
|
|
|
## Example Request
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/circle-crop \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@photo.jpg" \
|
|
-F 'settings={"zoom": 1.2, "borderWidth": 4, "borderColor": "#333333"}'
|
|
```
|
|
|
|
## Example Response
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/photo.png",
|
|
"originalSize": 2450000,
|
|
"processedSize": 185000
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- Output is always PNG to preserve the transparent corners (unless `background` is set to a solid color).
|
|
- The circle is inscribed within the shorter dimension of the image. Use `zoom` to crop tighter and `offsetX`/`offsetY` to shift the visible area.
|
|
- When `outputSize` is provided, the result is resized to that square dimension after cropping.
|
|
- HEIC, RAW, PSD, and SVG inputs are automatically decoded before processing.
|