forms.fill
Fill form fields, optionally flattening the form.
POST /v1/forms/fill
| Input | one file, sent as multipart/form-data; the optional options part is a JSON object |
| Output | one PDF |
| Credits | [credit rate: no claim ID yet] |
| 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 |
|---|---|---|---|---|
flatten |
boolean | no | false |
Flatten the form after filling. Default false. |
password |
string | no | Password of an encrypted document. | |
values |
object | yes | Field name to value. A string for text, radio and dropdown fields, true or false for check boxes, a list of strings for multi-select lists. |
Example
Section titled “Example”curl -sS -f -X POST "$PDFLUENT_API_URL/v1/forms/fill" \ -H "x-api-key: $PDFLUENT_API_KEY" \ -o result.pdfimport jsonimport os
import requests
parts = [ ("file", ("acroform.pdf", open("acroform.pdf", "rb"))), ("options", (None, json.dumps(options))),]
response = requests.post( os.environ["PDFLUENT_API_URL"] + "/v1/forms/fill", 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("acroform.pdf"), "acroform.pdf");
const response = await fetch(process.env.PDFLUENT_API_URL + "/v1/forms/fill", { 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.