mirror of https://github.com/snapotter-hq/SnapOtter.git synced 2026-08-03 07:46:42 +02:00

Files

T

SnapOtter 8532f3227b 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.

2026-06-18 14:12:28 +08:00

1.4 KiB

Raw Blame History

description

description
Mux a subtitle track into the video container.

Embed Subtitles

Mux a subtitle file into the video container as a soft subtitle track that viewers can toggle on or off.

API Endpoint

POST /api/v1/tools/embed-subtitles

Accepts multipart form data with a video file and a subtitle file, plus a JSON settings field.

Parameters

Parameter	Type	Required	Default	Description
language	string	No	`"eng"`	ISO 639-2/B language code (3 lowercase letters, e.g. `"eng"`, `"fra"`, `"deu"`)

Example Request

curl -X POST http://localhost:1349/api/v1/tools/embed-subtitles \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@clip.mp4" \
  -F "file=@subtitles.srt" \
  -F 'settings={"language": "fra"}'

Example Response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/clip.mp4",
  "originalSize": 12500000,
  "processedSize": 12520000
}

Notes

Upload two files: the first must be a video, the second must be a subtitle file (.srt, .vtt, or .ass).
Embedded (soft) subtitles can be toggled by the viewer in their media player. For permanently visible subtitles, use the Burn Subtitles tool instead.
The language code is stored as metadata in the container and helps media players label the subtitle track.

1.4 KiB Raw Blame History