Files
SnapOtter/apps/docs/tools/video/convert-video.md
T

45 lines
1.4 KiB
Markdown
Raw Normal View History

---
description: Convert videos between MP4, MOV, and WebM.
---
# Convert Video
Convert videos between MP4, MOV, and WebM formats with configurable quality presets.
## API Endpoint
2026-06-21 00:12:59 +08:00
`POST /api/v1/tools/video/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
2026-06-21 00:12:59 +08:00
curl -X POST http://localhost:1349/api/v1/tools/video/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.