extract.markdown
Convert a PDF to markdown in reading order.
POST /v1/extract/markdown
| Input | one file, sent as multipart/form-data; the optional options part is a JSON object |
| Output | Markdown |
| Credits | credits per page by quality: fast 1, balanced 2, auto 3 |
| 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 |
Write running headers and footers into the markdown. Default false. |
pages |
array of integer | no | One-based pages. Default: all pages. | |
password |
string | no | Password of an encrypted document. | |
quality |
string | no | Extraction quality tier. Default fast. fast: Geometric extraction, no model. The default. balanced: The layout-model tier. Answers quality_unavailable (501) on a deployment without the layout model. auto: Reads with the layout and table models and OCR of scanned pages. Answers quality_unavailable (501) when any of them is missing; it never reads fast in its place. |
Example
Section titled “Example”curl -sS -f -X POST "$PDFLUENT_API_URL/v1/extract/markdown" \ -H "x-api-key: $PDFLUENT_API_KEY" \ -o result.mdimport jsonimport os
import requests
parts = [ ("file", ("structured.pdf", open("structured.pdf", "rb"))),]
response = requests.post( os.environ["PDFLUENT_API_URL"] + "/v1/extract/markdown", headers={"x-api-key": os.environ["PDFLUENT_API_KEY"]}, files=parts,)response.raise_for_status()
with open("result.md", "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/extract/markdown", { 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.md", 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.