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

Raw Blame History

description

description
Shrink PDF file size by compressing embedded images.

Compress PDF

Reduce PDF file size by downsampling embedded images. Choose between a quality slider or a target file size.

API Endpoint

POST /api/v1/tools/compress-pdf

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

Parameters

Parameter	Type	Required	Default	Description
mode	string	No	`"quality"`	Compression mode: `quality` or `targetSize`
quality	integer	No	-	Compression quality, 1-100 (higher = less compression). Used in `quality` mode
targetSizeKb	number	No	-	Target file size in kilobytes. Used in `targetSize` mode

Example Request

Compress by quality:

curl -X POST http://localhost:1349/api/v1/tools/compress-pdf \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@document.pdf" \
  -F 'settings={"mode": "quality", "quality": 60}'

Compress to a target size:

curl -X POST http://localhost:1349/api/v1/tools/compress-pdf \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@document.pdf" \
  -F 'settings={"mode": "targetSize", "targetSizeKb": 500}'

Example Response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/document.pdf",
  "originalSize": 5200000,
  "processedSize": 1800000
}

Notes

In quality mode, lower values produce smaller files with more image degradation.
In targetSize mode, a binary search finds the highest DPI that fits the requested size.
If compression would enlarge the file, the original bytes are returned unchanged.
Text and vector content are not affected; only embedded raster images are downsampled.

1.8 KiB Raw Blame History