partition
Split a PDF into canonical elements (titles, paragraphs, lists, tables, figures) with stable ids.
POST /v1/partition
| Input | one file, sent as multipart/form-data; the optional options part is a JSON object |
| Output | JSON |
| Credits | credits per page by quality: fast 1, auto 3, max 5 (max also describes figures and tables with a model: two per page are included and each one above that costs 1 more credit, up to six per page) |
| Limits | [size, page and time limits: no claim ID yet] |
| Reads or changes the document | reads only |
| Error statuses | 400, 413, 422, 500, 501, 504 (see Errors) |
Options
Section titled “Options”| Option | Type | Required | Default | Description |
|---|---|---|---|---|
keep_furniture |
boolean | no | false |
Keep running headers and footers as elements. Default false. |
max_figures_per_page |
integer | no | max only: most figures and tables described per page, 1 to 6. Default 2; each one above two costs 1 more credit. |
|
pages |
array of integer | no | One-based pages to partition. Default: all pages. | |
password |
string | no | Password of an encrypted document. | |
quality |
string | no | Extraction quality tier. Default fast. max also describes every figure and table with a model (up to two per page included in the price), in description on each element. fast: Geometric extraction, no model, no OCR. The default. auto: fast plus OCR of scanned pages. Answers quality_unavailable (501) on a deployment without an OCR engine. max: The full reading the engine gives, plus a short model description of every figure and table (up to two per page are included in the price). Not part of the trial. With your own model key (x-byok-model-key) only the processing credits are charged: 3 a page, no Max uplift and no extra-figure charge. |
Example
Section titled “Example”curl -sS -f -X POST "$PDFLUENT_API_URL/v1/partition" \ -H "x-api-key: $PDFLUENT_API_KEY" \ -o result.jsonimport jsonimport os
import requests
parts = [ ("file", ("structured.pdf", open("structured.pdf", "rb"))),]
response = requests.post( os.environ["PDFLUENT_API_URL"] + "/v1/partition", headers={"x-api-key": os.environ["PDFLUENT_API_KEY"]}, files=parts,)response.raise_for_status()
with open("result.json", "wb") as out: out.write(response.content)import { openAsBlob } from 'node:fs';import { writeFile } from 'node:fs/promises';
const form = new FormData();form.append('file', await openAsBlob("structured.pdf"), "structured.pdf");
const response = await fetch(process.env.PDFLUENT_API_URL + "/v1/partition", { method: 'POST', headers: { 'x-api-key': process.env.PDFLUENT_API_KEY }, body: form,});if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
await writeFile("result.json", Buffer.from(await response.arrayBuffer()));The key goes in the x-api-key header; see Authentication. Every response carries x-pdfluent-pages and x-pdfluent-credits.