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

Files

T

SnapOtterandGitHub ecc0a45f0e docs: per-tool reference pages for all 157 tools (+ fix docs build) (#261 )

* fix(docs): keep gray-matter on js-yaml 3 so the docs site builds

The js-yaml >=4.2.0 override from #257 forced js-yaml 4 onto gray-matter (used by vitepress and vitepress-plugin-llms), which calls the removed yaml.safeLoad and broke `vitepress build`. Scope a gray-matter>js-yaml ^3.14.1 override so gray-matter keeps the v3 API (build-time, trusted frontmatter only) while app code stays on js-yaml 4.2.0+.

* docs: add per-tool reference pages for all 157 tools, with a modality sidebar

Generate /tools/<id> pages for the 104 tools that lacked one (video 29, audio 17, document 36, data 10, and 12 newer image tools), matching the existing page format (API endpoint, parameters from the OpenAPI spec, curl example, response, notes). Async/AI tools document the 202+SSE flow and feature-bundle requirement.

Sidebar: add Video / Audio / PDF & Documents / Data groups with per-tool links, fold the 12 new image tools into the existing image categories, and replace the placeholder rest.md-anchor group. Docs site builds cleanly (157 pages, no dead links).

2026-06-17 11:11:37 +08:00

1.7 KiB

Raw Blame History

description

description
Burn a text watermark onto video frames.

Watermark Video

Burn a text watermark onto every frame of a video with configurable position, size, opacity, and color.

API Endpoint

POST /api/v1/tools/watermark-video

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

Parameters

Parameter	Type	Required	Default	Description
text	string	Yes	-	Watermark text (1-200 characters)
position	string	No	`"br"`	Position on the frame: `tl`, `tc`, `tr`, `l`, `c`, `r`, `bl`, `bc`, `br`
fontSize	integer	No	`36`	Font size in pixels (8-120)
opacity	number	No	`0.5`	Watermark opacity (0.05-1)
color	string	No	`"#ffffff"`	Hex color for the text (e.g. `"#ffffff"`)

Position Values

tl - Top left, tc - Top center, tr - Top right
l - Middle left, c - Center, r - Middle right
bl - Bottom left, bc - Bottom center, br - Bottom right

Example Request

curl -X POST http://localhost:1349/api/v1/tools/watermark-video \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@clip.mp4" \
  -F 'settings={"text": "PREVIEW", "position": "c", "fontSize": 48, "opacity": 0.3}'

Example Response

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

Notes

The watermark is permanently rendered into the video frames and cannot be removed after processing.
The watermark uses a sans-serif font built into FFmpeg.
For image watermarks, use the image Watermark tool instead.

1.7 KiB Raw Blame History