forms.export
Export the form data as FDF, XFDF or XML.
POST /v1/forms/export
| Input | one file, sent as multipart/form-data; the optional options part is a JSON object |
| Output | bytes (content type stated per request) |
| Credits | [credit rate: no claim ID yet] |
| 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 |
|---|---|---|---|---|
format |
string | no | Output format. Default xfdf. fdf: Forms Data Format. xfdf: XML Forms Data Format. The default. xml: Plain XML. |
|
password |
string | no | Password of an encrypted document. |
Example
Section titled “Example”curl -sS -f -X POST "$PDFLUENT_API_URL/v1/forms/export" \ -H "x-api-key: $PDFLUENT_API_KEY" \ -F 'options={"format":"fdf"}' \ -o result.binimport jsonimport os
import requests
options = {"format": "fdf"}
parts = [ ("file", ("filled.pdf", open("filled.pdf", "rb"))), ("options", (None, json.dumps(options))),]
response = requests.post( os.environ["PDFLUENT_API_URL"] + "/v1/forms/export", headers={"x-api-key": os.environ["PDFLUENT_API_KEY"]}, files=parts,)response.raise_for_status()
with open("result.bin", "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("filled.pdf"), "filled.pdf");form.append('options', JSON.stringify({"format":"fdf"}));
const response = await fetch(process.env.PDFLUENT_API_URL + "/v1/forms/export", { 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.bin", 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.