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.7 KiB

Raw Blame History

description

description
Generate subtitle files from video audio tracks using AI.

Auto Subtitles

Generate subtitle files from a video's audio track using AI-powered speech recognition (faster-whisper). Supports auto-detection and 10 explicit languages.

API Endpoint

POST /api/v1/tools/auto-subtitles

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
language	string	No	`"auto"`	Speech language: `auto`, `en`, `de`, `fr`, `es`, `zh`, `ja`, `ko`, `id`, `th`, `vi`
format	string	No	`"srt"`	Output subtitle format: `srt`, `vtt`

Example Request

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

Example Response

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

Notes

This is an AI tool that requires the transcription feature bundle to be installed. If the bundle is not installed, the API returns 501 Feature Not Installed with instructions to install it via the admin UI.
The auto language option uses whisper's built-in language detection. Specifying the language explicitly improves accuracy and speed.
SRT is the most widely supported subtitle format. VTT (WebVTT) is the standard for web video players.
Progress updates are available via SSE at GET /api/v1/jobs/{jobId}/progress until the job completes.

1.7 KiB Raw Blame History