endpoint

Fill form

POST /api/v1/fill-form

Fill AcroForm fields by name. Unknown fields are returned so callers can diff against the PDF schema.

credits: 1returns: application/pdf

Parameters

Name	Type	Required	Description
file	multipart file	required	Source PDF with a form.
values	JSON string	required	Object of field name → value.
flatten	boolean	optional	Make fields uneditable after filling.

Examples

curl

curl -X POST https://api.snappdf.au/api/v1/fill-form \
  -H "Authorization: Bearer $SNAPPDF_API_KEY" \
  -F "file=@form.pdf" -F 'values={"name":"Jane","agree":true}' \
  -o filled.pdf

JavaScript

await snap.pdf.fillForm({ file: bytes, values: { name: 'Jane', agree: true } });

Python

snap.pdf.fill_form(file=bytes, values={"name": "Jane", "agree": True})

PHP

$snap->pdf->fillForm(file: $bytes, values: ['name' => 'Jane', 'agree' => true]);

Ruby

snap.pdf.fill_form(file: bytes, values: { name: 'Jane', agree: true })

client.FillForm(ctx, &snappdf.FillFormInput{File: bytes, Values: map[string]any{"name": "Jane", "agree": true}})

Try it in the playground Back to docs