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).
67 lines
2.0 KiB
Markdown
67 lines
2.0 KiB
Markdown
---
|
|
description: Apply a pixelation effect to the full image or a specific region.
|
|
---
|
|
|
|
# Pixelate
|
|
|
|
Apply a pixelation effect to an entire image or a specific rectangular region. Useful for obscuring sensitive content like faces, license plates, or personal information.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/pixelate`
|
|
|
|
Accepts multipart form data with an image file and a JSON `settings` field.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| blockSize | integer | No | `12` | Pixel block size (2-128); larger values produce coarser pixelation |
|
|
| region | object | No | - | Restrict pixelation to a rectangle (see below) |
|
|
|
|
### Region Object
|
|
|
|
| Field | Type | Required | Description |
|
|
|-------|------|----------|-------------|
|
|
| left | integer | Yes | Left offset in pixels (>= 0) |
|
|
| top | integer | Yes | Top offset in pixels (>= 0) |
|
|
| width | integer | Yes | Region width in pixels (>= 1) |
|
|
| height | integer | Yes | Region height in pixels (>= 1) |
|
|
|
|
## Example Request
|
|
|
|
Pixelate the full image:
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/pixelate \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@photo.jpg" \
|
|
-F 'settings={"blockSize": 20}'
|
|
```
|
|
|
|
Pixelate a specific region:
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/pixelate \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@photo.jpg" \
|
|
-F 'settings={"blockSize": 16, "region": {"left": 100, "top": 50, "width": 200, "height": 150}}'
|
|
```
|
|
|
|
## Example Response
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/photo.jpg",
|
|
"originalSize": 2450000,
|
|
"processedSize": 2380000
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- When `region` is omitted, the entire image is pixelated.
|
|
- The region coordinates are in pixels relative to the top-left corner of the image. The region must fall within the image bounds.
|
|
- Output format matches the input format. HEIC, RAW, PSD, and SVG inputs are automatically decoded before processing.
|