Document split into pages

POST /api/document-split-pages2 quota units per call · cache hits free

Split an image that contains multiple document pages stacked vertically (a long phone snapshot of a multi-page handout, a tall scan, etc.) into one image per page using horizontal-projection segmentation.

Detects the natural page breaks in a tall image containing multiple stacked document pages and returns one image per detected page. The algorithm: 1. Binarize the image (auto-threshold) — black = ink, white = background. 2. Sum the ink-density of each row → a horizontal projection histogram. 3. Find long runs of low-density rows — those are the gaps between pages. 4. Crop one sub-image per inter-gap content block. Useful for: - A user photographed a 4-page printout on one long phone capture and wants individual page images. - A multi-page scan landed as a single tall TIFF / PNG. - Pre-processing for downstream per-page OCR. Returns JSON with one `{ image, width, height }` object per detected page. Page images are base64-encoded PNG or JPEG. Tunables: `minGapPx` (minimum white-gap pixels to count as a page break) and `minPageHeightPx` (drop content blocks shorter than this).

Inputs

Name	Type	Default	Description
image*	file	—	Tall image with multiple document pages stacked vertically.
minGapPx	number (4…1000)	40	Minimum height of a near-white gap (in pixels) before it counts as a page break.
minPageHeightPx	number (20…10000)	100	Drop detected page blocks shorter than this — filters out stray marks between real pages.
format	enum (png \| jpeg)	"jpeg"	Per-page output format.

Response

Modes: json. Cache: yes (24h TTL).

Every response carries x-cache (HIT / MISS / BYPASS), x-cache-signature (stable across identical inputs), and the rate-limit headers listed below.

Quota & limits

Cost per call	2 units against the 10,000-unit monthly quota. Cache hits are free — only cache misses decrement.
Burst limit	200 requests per rolling minute, shared across all tools.
Max request size	`4 MiB` (base64 inflates file payloads ~33% — the limit applies to the decoded bytes).
Max response size	`25 MiB`
Timeout	20s wall clock.
Rate-limit headers	`X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Burst-Limit` on every response; `X-Quota-Warning` once 80% of the monthly quota is spent; `Retry-After` on 429s.

Errors

Errors are JSON with an error string; schema failures add a details object (Zod's flattened field errors).

Status	When	Body
400	Input fails the tool's schema (wrong type, missing required field, malformed base64) or the file bytes can't be parsed as the expected format.	{ "error": "invalid inputs", "details": { "fieldErrors": { … } } }
401	Missing or invalid X-Api-Key / X-Account-Id headers (or no session when called from the browser).	{ "error": "unauthorized" }
404	Unknown tool id, or calling /api/* on the website hostname instead of api.xtract.bot.	{ "error": "not found" }
413	Request body over the tool's max request size, or an image header declaring more megapixels than the tool's pixel budget.	{ "error": "…exceeds maxRequestBytes…" }
415	Content-Type isn't application/json on the json-body transport.	{ "error": "unsupported content-type; expected application/json" }
429	Monthly quota or the 200/min burst limit exhausted. Check Retry-After and the X-RateLimit-* headers.	{ "error": "monthly quota exceeded", "monthRemaining": 0, … }
5xx	Conversion engine failure. Safe to retry; if it persists, the input is hitting a bug — please report it.	{ "error": "…" }

Code samples

Built from the four-pages example.

# Download or substitute the example input:
#   curl -O https://xtract.bot/examples/document-split-pages/sample.png
IMAGE=$(base64 -w0 < sample.png)

curl -X POST https://api.xtract.bot/api/document-split-pages \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-Account-Id: $XTRACT_ACCOUNT_ID" \
  -H "X-Api-Key: $XTRACT_API_KEY" \
  -d '{
  "minGapPx": 40,
  "minPageHeightPx": 60,
  "format": "jpeg",
  "image": "'"$IMAGE"'"
}'