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.
47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
---
|
|
description: Add solid-color bars to fit a target aspect ratio.
|
|
---
|
|
|
|
# Aspect Pad
|
|
|
|
Add solid-color letterbox or pillarbox bars to fit a video into a target aspect ratio without cropping.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/aspect-pad`
|
|
|
|
Accepts multipart form data with a video file and a JSON `settings` field.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| target | string | No | `"9:16"` | Target aspect ratio: `16:9`, `9:16`, `1:1`, `4:3`, `3:4` |
|
|
| color | string | No | `"#000000"` | Hex color for the padding bars (e.g. `"#000000"` for black) |
|
|
|
|
## Example Request
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/aspect-pad \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@clip.mp4" \
|
|
-F 'settings={"target": "1:1", "color": "#ffffff"}'
|
|
```
|
|
|
|
## Example Response
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/clip.mp4",
|
|
"originalSize": 12500000,
|
|
"processedSize": 13200000
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- If the video already matches the target aspect ratio, the file is returned unchanged.
|
|
- Use `9:16` for vertical/portrait social media formats (TikTok, Reels, Shorts).
|
|
- For blurred padding instead of solid color, use the Blur Pad tool.
|