docs: audit all 157 tool pages against live schemas

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.
This commit is contained in:
SnapOtter
2026-06-18 14:12:28 +08:00
parent d24e244af4
commit 8532f3227b
160 changed files with 518 additions and 441 deletions
+3 -3
View File
@@ -8,7 +8,7 @@ Turn a video clip into an animated GIF with configurable frame rate, width, star
## API Endpoint
`POST /api/v1/tools/video/video-to-gif`
`POST /api/v1/tools/video-to-gif`
Accepts multipart form data with a video file and a JSON `settings` field. This is an async endpoint - it returns `202 Accepted` immediately and progress is streamed via SSE at `GET /api/v1/jobs/{jobId}/progress`.
@@ -19,12 +19,12 @@ Accepts multipart form data with a video file and a JSON `settings` field. This
| fps | integer | No | `12` | Output frame rate (1-30) |
| width | integer | No | `480` | Output width in pixels (64-1280). Height scales proportionally |
| startS | number | No | `0` | Start time in seconds (must be >= 0) |
| durationS | number | No | `5` | Duration in seconds (0-60) |
| durationS | number | No | `5` | Duration in seconds (above 0, max 60) |
## Example Request
```bash
curl -X POST http://localhost:1349/api/v1/tools/video/video-to-gif \
curl -X POST http://localhost:1349/api/v1/tools/video-to-gif \
-H "Authorization: Bearer si_your-api-key" \
-F "file=@clip.mp4" \
-F 'settings={"fps": 15, "width": 320, "startS": 2, "durationS": 8}'