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

Files

T

SnapOtter d24e244af4 docs: organize tool pages by modality under /tools/<modality>/

Move all 157 tool pages into image/video/audio/pdf/data subfolders so URLs read /tools/<modality>/<id> (e.g. /tools/image/crop). Nest the image sub-categories under an Image group in the sidebar so the nav reads by modality. Add public/_redirects (301, clean + .html forms) mapping every old flat /tools/<id> URL to its new path so inbound links keep working. Rewrite all internal /tools links. Verified with a clean docs build (no dead links).

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

1.3 KiB

Raw Blame History

description

description
Permanently render subtitles onto video frames.

Burn Subtitles

Permanently render (hard-code) subtitles from an SRT, VTT, or ASS file onto every frame of a video.

API Endpoint

POST /api/v1/tools/video/burn-subtitles

Accepts multipart form data with a video file and a subtitle file. 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
fontSize	integer	No	`24`	Subtitle font size in pixels (8-72)

Example Request

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

Example Response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "async": true
}

Notes

Upload two files: the first must be a video, the second must be a subtitle file (.srt, .vtt, or .ass).
Burned subtitles are permanently part of the video and cannot be turned off by the viewer. For toggleable subtitles, use the Embed Subtitles tool instead.
Progress updates are available via SSE at GET /api/v1/jobs/{jobId}/progress until the job completes.

1.3 KiB Raw Blame History