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

2.0 KiB

Raw Blame History

description

description
Add a vignette effect with adjustable strength, color, and position.

Vignette

Add a vignette effect that darkens or tints the edges of an image. Supports adjustable strength, color, radius, softness, roundness, and center position.

API Endpoint

POST /api/v1/tools/vignette

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

Parameters

Parameter	Type	Required	Default	Description
strength	number	No	`0.5`	Vignette opacity (0.1-1)
color	string	No	`"#000000"`	Vignette hex color
radius	integer	No	`70`	Outer radius as percentage of half-diagonal (0-100)
softness	integer	No	`50`	Feather softness (0-100); higher values produce a more gradual fade
roundness	integer	No	`100`	Shape: 100 = circle, 0 = ellipse matching image aspect ratio
centerX	integer	No	`50`	Horizontal center position as percentage (0-100)
centerY	integer	No	`50`	Vertical center position as percentage (0-100)

Example Request

curl -X POST http://localhost:1349/api/v1/tools/vignette \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@photo.jpg" \
  -F 'settings={"strength": 0.7, "radius": 60, "softness": 70}'

Example Response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/photo.jpg",
  "originalSize": 2450000,
  "processedSize": 2410000
}

Notes

A smaller radius darkens more of the image; a larger radius confines the vignette to the extreme edges.
Use a non-black color (e.g., white or sepia tones) for creative vignette effects.
Adjusting centerX and centerY lets you position the clear area off-center, useful for drawing focus to a subject that is not in the middle of the frame.
Output format matches the input format. HEIC, RAW, PSD, and SVG inputs are automatically decoded before processing.

2.0 KiB Raw Blame History