mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtter
8532f3227b
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.
45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
---
|
|
description: Convert videos between MP4, MOV, and WebM.
|
|
---
|
|
|
|
# Convert Video
|
|
|
|
Convert videos between MP4, MOV, and WebM formats with configurable quality presets.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/convert-video`
|
|
|
|
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`.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| format | string | No | `"mp4"` | Output format: `mp4`, `mov`, `webm` |
|
|
| quality | string | No | `"balanced"` | Quality preset: `high`, `balanced`, `small` |
|
|
|
|
## Example Request
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/convert-video \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@clip.mp4" \
|
|
-F 'settings={"format": "webm", "quality": "balanced"}'
|
|
```
|
|
|
|
## Example Response
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"async": true
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- The `high` quality preset produces the best visual fidelity but larger files. The `small` preset aggressively compresses for minimum file size.
|
|
- WebM output uses VP9 encoding. MP4 and MOV use H.264.
|
|
- Progress updates are available via SSE at `GET /api/v1/jobs/{jobId}/progress` until the job completes.
|