# API reference

> Every operation of the PDFluent hosted API, with its options, credit rule and an example in curl, Python and Node.js.

> Coming soon. The hosted API is not live yet, and this page describes the planned service as of 16 November 2026. [Get notified](https://pdfluent.com/contact/?topic=hosted) when it opens.

Source: https://pdfluent.com/docs/api/reference/

One page per operation, generated from the API contract (registry version 4, XFA `claude/hosted-next-int` at `e09fa4cf2204`). Every operation is `POST` with `multipart/form-data`: one or more `file` parts and an optional `options` part holding a JSON object. Unknown form fields and unknown options are refused with `400`.

| Operation | Path | Output | Credits |
|---|---|---|---|
| [`compat.unstructured_general`](https://pdfluent.com/docs/api/reference/compat-unstructured-general/) | `POST /v1/compat/unstructured/general` | JSON | [credit rate: no claim ID yet] |
| [`convert.email`](https://pdfluent.com/docs/api/reference/convert-email/) | `POST /v1/convert/email` | one PDF | 1 credit per page |
| [`convert.html`](https://pdfluent.com/docs/api/reference/convert-html/) | `POST /v1/convert/html` | one PDF | 1 credit per page |
| [`convert.template`](https://pdfluent.com/docs/api/reference/convert-template/) | `POST /v1/convert/template` | one PDF | 1 credit per page |
| [`convert.to_images`](https://pdfluent.com/docs/api/reference/convert-to-images/) | `POST /v1/convert/to-images` | a zip of files | 1 credit per page |
| [`convert.to_pptx`](https://pdfluent.com/docs/api/reference/convert-to-pptx/) | `POST /v1/convert/to-pptx` | a PowerPoint file | 1 credit per page |
| [`convert.to_xlsx`](https://pdfluent.com/docs/api/reference/convert-to-xlsx/) | `POST /v1/convert/to-xlsx` | an Excel workbook | 1 credit per page |
| [`convert.url`](https://pdfluent.com/docs/api/reference/convert-url/) | `POST /v1/convert/url` | one PDF | 1 credit per page |
| [`extract.chunks`](https://pdfluent.com/docs/api/reference/extract-chunks/) | `POST /v1/extract/chunks` | JSON | credits per page by quality: `fast` 1, `auto` 3 |
| [`extract.embeddings`](https://pdfluent.com/docs/api/reference/extract-embeddings/) | `POST /v1/extract/embeddings` | JSON | credits per page by quality: `fast` 1, `auto` 3 |
| [`extract.images`](https://pdfluent.com/docs/api/reference/extract-images/) | `POST /v1/extract/images` | a zip of files | [credit rate: no claim ID yet] |
| [`extract.markdown`](https://pdfluent.com/docs/api/reference/extract-markdown/) | `POST /v1/extract/markdown` | Markdown | credits per page by quality: `fast` 1, `balanced` 2, `auto` 3 |
| [`extract.schema`](https://pdfluent.com/docs/api/reference/extract-schema/) | `POST /v1/extract/schema` | JSON | credits per page by quality: `fast` 1, `auto` 3 |
| [`extract.tables`](https://pdfluent.com/docs/api/reference/extract-tables/) | `POST /v1/extract/tables` | JSON | 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) |
| [`extract.text`](https://pdfluent.com/docs/api/reference/extract-text/) | `POST /v1/extract/text` | plain text | [credit rate: no claim ID yet] |
| [`forms.export`](https://pdfluent.com/docs/api/reference/forms-export/) | `POST /v1/forms/export` | bytes (content type stated per request) | [credit rate: no claim ID yet] |
| [`forms.fields`](https://pdfluent.com/docs/api/reference/forms-fields/) | `POST /v1/forms/fields` | JSON | [credit rate: no claim ID yet] |
| [`forms.fill`](https://pdfluent.com/docs/api/reference/forms-fill/) | `POST /v1/forms/fill` | one PDF | [credit rate: no claim ID yet] |
| [`forms.import`](https://pdfluent.com/docs/api/reference/forms-import/) | `POST /v1/forms/import` | one PDF | [credit rate: no claim ID yet] |
| [`forms.xfa_flatten`](https://pdfluent.com/docs/api/reference/forms-xfa-flatten/) | `POST /v1/forms/xfa/flatten` | one PDF | [credit rate: no claim ID yet] |
| [`info`](https://pdfluent.com/docs/api/reference/info/) | `POST /v1/info` | JSON | [credit rate: no claim ID yet] |
| [`partition`](https://pdfluent.com/docs/api/reference/partition/) | `POST /v1/partition` | JSON | 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) |
| [`pdf.compress`](https://pdfluent.com/docs/api/reference/pdf-compress/) | `POST /v1/pdf/compress` | one PDF | 1 credit per 10 pages, rounded up to whole blocks of 10 pages, with a minimum of 1 credit |
| [`pdf.decrypt`](https://pdfluent.com/docs/api/reference/pdf-decrypt/) | `POST /v1/pdf/decrypt` | one PDF | 1 credit per 10 pages, rounded up to whole blocks of 10 pages, with a minimum of 1 credit |
| [`pdf.encrypt`](https://pdfluent.com/docs/api/reference/pdf-encrypt/) | `POST /v1/pdf/encrypt` | one PDF | 1 credit per 10 pages, rounded up to whole blocks of 10 pages, with a minimum of 1 credit |
| [`pdf.flatten`](https://pdfluent.com/docs/api/reference/pdf-flatten/) | `POST /v1/pdf/flatten` | one PDF | 1 credit per 10 pages, rounded up to whole blocks of 10 pages, with a minimum of 1 credit |
| [`pdf.merge`](https://pdfluent.com/docs/api/reference/pdf-merge/) | `POST /v1/pdf/merge` | one PDF | 1 credit per 10 pages, rounded up to whole blocks of 10 pages, with a minimum of 1 credit |
| [`pdf.metadata`](https://pdfluent.com/docs/api/reference/pdf-metadata/) | `POST /v1/pdf/metadata` | one PDF | 1 credit per 10 pages, rounded up to whole blocks of 10 pages, with a minimum of 1 credit |
| [`pdf.pages`](https://pdfluent.com/docs/api/reference/pdf-pages/) | `POST /v1/pdf/pages` | one PDF | 1 credit per 10 pages, rounded up to whole blocks of 10 pages, with a minimum of 1 credit |
| [`pdf.redact`](https://pdfluent.com/docs/api/reference/pdf-redact/) | `POST /v1/pdf/redact` | one PDF | 1 credit per 10 pages, rounded up to whole blocks of 10 pages, with a minimum of 1 credit |
| [`pdf.replace_text`](https://pdfluent.com/docs/api/reference/pdf-replace-text/) | `POST /v1/pdf/replace-text` | one PDF | 1 credit per 10 pages, rounded up to whole blocks of 10 pages, with a minimum of 1 credit |
| [`pdf.split`](https://pdfluent.com/docs/api/reference/pdf-split/) | `POST /v1/pdf/split` | a zip of files | 1 credit per 10 pages, rounded up to whole blocks of 10 pages, with a minimum of 1 credit |
| [`pdf.watermark`](https://pdfluent.com/docs/api/reference/pdf-watermark/) | `POST /v1/pdf/watermark` | one PDF | 1 credit per 10 pages, rounded up to whole blocks of 10 pages, with a minimum of 1 credit |
| [`pdfa.convert`](https://pdfluent.com/docs/api/reference/pdfa-convert/) | `POST /v1/pdfa/convert` | one PDF | 1 credit per page |
| [`pdfa.validate`](https://pdfluent.com/docs/api/reference/pdfa-validate/) | `POST /v1/pdfa/validate` | JSON | [credit rate: no claim ID yet] |
| [`pdfua.check`](https://pdfluent.com/docs/api/reference/pdfua-check/) | `POST /v1/pdfua/check` | JSON | [credit rate: no claim ID yet] |
| [`search`](https://pdfluent.com/docs/api/reference/search/) | `POST /v1/search` | JSON | [credit rate: no claim ID yet] |
| [`signatures.verify`](https://pdfluent.com/docs/api/reference/signatures-verify/) | `POST /v1/signatures/verify` | JSON | [credit rate: no claim ID yet] |
| [`zugferd.create`](https://pdfluent.com/docs/api/reference/zugferd-create/) | `POST /v1/zugferd/create` | one PDF | [credit rate: no claim ID yet] |

The job routes run work asynchronously and are described under [Async jobs](https://pdfluent.com/docs/api/jobs/). The contract itself is [openapi.json](https://pdfluent.com/docs/api/openapi.json).
