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

Files

T

SnapOtter 8532f3227b docs: audit all 157 tool pages against live schemas

Reconcile every tool page's parameters, defaults, and response shape against the tool's Zod settings schema and executionHint in code. Notable fixes: color-palette (add count + format params, hex output, median-cut algorithm), favicon (add 5 params, was documented as having none), qr-generate (add logoDataUri), convert (add ppm/eps/tga formats), video-loudnorm (-16 LUFS not -14), smart-crop (async 202 not sync 200), images-to-video (1080x1080 square), and several output-filename and behavior-note corrections.

Also normalize API endpoint paths to /api/v1/tools/<id> (no modality segment) and standardize curl examples on the Docker API port 1349. Verified with a clean docs build.

2026-06-18 14:12:28 +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