pdfa.convert
Convert a PDF toward PDF/A and report whether the result validates; not every document converts to a conforming file, so read x-pdfluent-compliant and x-pdfluent-violations from the response.
POST /v1/pdfa/convert
| Input | one file, sent as multipart/form-data; the optional options part is a JSON object |
| Output | one PDF |
| Credits | 1 credit per page |
| Limits | [size, page and time limits: no claim ID yet] |
| Reads or changes the document | returns a changed copy |
| Error statuses | 400, 413, 422, 500, 501, 504 (see Errors) |
Options
Section titled “Options”| Option | Type | Required | Default | Description |
|---|---|---|---|---|
password |
string | no | Password of an encrypted document. | |
profile |
string | no | Profile to check against. Default a2b. a1b: PDF/A-1b. a2b: PDF/A-2b. The default. a3b: PDF/A-3b. |
Example
Section titled “Example”curl -sS -f -X POST "$PDFLUENT_API_URL/v1/pdfa/convert" \ -H "x-api-key: $PDFLUENT_API_KEY" \ -o result.pdfimport jsonimport os
import requests
parts = [ ("file", ("structured.pdf", open("structured.pdf", "rb"))),]
response = requests.post( os.environ["PDFLUENT_API_URL"] + "/v1/pdfa/convert", headers={"x-api-key": os.environ["PDFLUENT_API_KEY"]}, files=parts,)response.raise_for_status()
with open("result.pdf", "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/pdfa/convert", { 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.pdf", 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.