mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
docs: organize tool pages by modality under /tools/<modality>/
Move all 157 tool pages into image/video/audio/pdf/data subfolders so URLs read /tools/<modality>/<id> (e.g. /tools/image/crop). Nest the image sub-categories under an Image group in the sidebar so the nav reads by modality. Add public/_redirects (301, clean + .html forms) mapping every old flat /tools/<id> URL to its new path so inbound links keep working. Rewrite all internal /tools links. Verified with a clean docs build (no dead links).
This commit is contained in:
@@ -0,0 +1,52 @@
|
||||
---
|
||||
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/image/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/image/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.
|
||||
Reference in New Issue
Block a user