mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
ecc0a45f0e
* fix(docs): keep gray-matter on js-yaml 3 so the docs site builds The js-yaml >=4.2.0 override from #257 forced js-yaml 4 onto gray-matter (used by vitepress and vitepress-plugin-llms), which calls the removed yaml.safeLoad and broke `vitepress build`. Scope a gray-matter>js-yaml ^3.14.1 override so gray-matter keeps the v3 API (build-time, trusted frontmatter only) while app code stays on js-yaml 4.2.0+. * docs: add per-tool reference pages for all 157 tools, with a modality sidebar Generate /tools/<id> pages for the 104 tools that lacked one (video 29, audio 17, document 36, data 10, and 12 newer image tools), matching the existing page format (API endpoint, parameters from the OpenAPI spec, curl example, response, notes). Async/AI tools document the 202+SSE flow and feature-bundle requirement. Sidebar: add Video / Audio / PDF & Documents / Data groups with per-tool links, fold the 12 new image tools into the existing image categories, and replace the placeholder rest.md-anchor group. Docs site builds cleanly (157 pages, no dead links).
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.
|