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.
46 lines
1.1 KiB
Markdown
46 lines
1.1 KiB
Markdown
---
|
|
description: Increase or decrease audio volume by a fixed gain in decibels.
|
|
---
|
|
|
|
# Volume Adjust
|
|
|
|
Increase or decrease the volume of an audio file by applying a fixed gain in decibels.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/volume-adjust`
|
|
|
|
Accepts multipart form data with an audio file and a JSON `settings` field.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| gainDb | number | No | `3` | Volume adjustment in decibels (-30 to 30) |
|
|
|
|
## Example Request
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/volume-adjust \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@audio.mp3" \
|
|
-F 'settings={"gainDb": 6}'
|
|
```
|
|
|
|
## Example Response
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/audio.mp3",
|
|
"originalSize": 4500000,
|
|
"processedSize": 4500000
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- Positive values increase volume; negative values decrease it.
|
|
- Large positive gains can cause clipping. Use normalize-audio for loudness-safe leveling.
|
|
- Output format matches the input format.
|