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

Raw Blame History

description

description
Generate a waveform visualization as a PNG image from an audio file.

Waveform Image

Generate a waveform visualization as a PNG image from an audio file, with configurable dimensions and color.

API Endpoint

POST /api/v1/tools/waveform-image

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

Parameters

Parameter	Type	Required	Default	Description
width	integer	No	`1024`	Image width in pixels (256 to 3840)
height	integer	No	`256`	Image height in pixels (64 to 1080)
color	string	No	`"#4f46e5"`	Waveform hex color (e.g. `"#4f46e5"`)

Example Request

curl -X POST http://localhost:1349/api/v1/tools/waveform-image \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@audio.mp3" \
  -F 'settings={"width": 1920, "height": 400, "color": "#e07832"}'

Example Response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/audio.png",
  "originalSize": 4500000,
  "processedSize": 45000
}

Notes

The output is always a PNG image, regardless of the input audio format.
The waveform is rendered on a transparent background.
Useful for thumbnails, social media previews, or embedding in web pages.

1.3 KiB Raw Blame History