External/SnapOtter
1
0
Fork 0
mirror of https://github.com/snapotter-hq/SnapOtter.git synced 2026-08-03 07:46:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: per-tool reference pages for all 157 tools (+ fix docs build) (#261)

Browse Source 
* 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).
This commit is contained in:
SnapOtter
2026-06-17 11:11:37 +08:00
committed by GitHub
parent c3d7411c67
commit ecc0a45f0e
107 changed files with 5122 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/tools/background-replace.md
+52
View File
@@ -0,0 +1,52 @@
---
description: Replace image background with a solid color or gradient using AI.
---
# Background Replace
Replace the background of an image with a solid color or gradient. The AI model detects the subject, removes the original background, and composites the subject onto your chosen background.
## API Endpoint
`POST /api/v1/tools/background-replace`
Accepts multipart form data with an image file and a JSON `settings` field.
## Parameters
| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| backgroundType | string | No | `"color"` | Background mode: `color` or `gradient` |
| color | string | No | `"#ffffff"` | Background hex color (when backgroundType is `color`) |
| gradientColor1 | string | No | - | First gradient hex color |
| gradientColor2 | string | No | - | Second gradient hex color |
| gradientAngle | integer | No | `180` | Gradient angle in degrees (0-360) |
| feather | integer | No | `0` | Edge feathering radius (0-20) |
| format | string | No | `"png"` | Output format: `png` or `webp` |
## Example Request
```bash
curl -X POST http://localhost:1349/api/v1/tools/background-replace \
-H "Authorization: Bearer si_your-api-key" \
-F "file=@photo.jpg" \
-F 'settings={"backgroundType": "color", "color": "#2563eb", "feather": 2}'
```
## Example Response
```json
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"async": true
}
```
Track progress via SSE at `GET /api/v1/jobs/{jobId}/progress`. When the job completes, the SSE stream emits a `completed` event with the download URL.
## Notes
- This is an AI-powered tool that returns `202 Accepted` and processes asynchronously. Connect to the SSE endpoint to receive progress updates and the final result.
- Requires the **background-removal** feature bundle to be installed. Returns `501` if the bundle is not available.
- HEIC, RAW, PSD, and SVG inputs are automatically decoded before processing.
- Output defaults to PNG to preserve transparency around the subject.