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

Raw Blame History

description

description
Extract pages or split a PDF into parts.

Split PDF

Extract a range of pages into a new PDF, or split a document into chunks of N pages.

API Endpoint

POST /api/v1/tools/split-pdf

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

Parameters

Parameter	Type	Required	Default	Description
mode	string	No	`"range"`	Split mode: `range` or `every`
range	string	When mode is `range`	-	Page range in qpdf syntax, e.g. `"1-5,8,10-z"`
everyN	integer	When mode is `every`	-	Split into chunks of N pages (1-500)

Example Request

Extract specific pages:

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

Split into chunks of 10 pages:

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

Example Response

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

Notes

In range mode, a single PDF containing the selected pages is returned.
In every mode, the result is a ZIP archive containing the individual parts.
Page ranges use qpdf syntax: 1-5 for pages 1 through 5, z for the last page, and commas to combine ranges (e.g. 1-3,7,10-z).

1.6 KiB Raw Blame History