Skip to navigation
Paperwork APITemplates

Detect a template’s fillable fields

View as Markdown

Enumerates the fillable fields in a pdf-form template, with the page geometry to draw them on.

The response is { fields, pageBoxes, pageCount, detected }. Each field carries its name, type, label, page and bounding box — plus maxLength, multiline and options where the widget declares them. The names you see here are exactly the keys values takes on POST /v1/fill. Save the curated fields onto a fill config to fix the schema for every run.

If the PDF carries no form fields of its own, they are detected from the page instead and detected says so.

Any PDF you can reach works here, not only a saved template — a file in one of your spaces is inspected the same way.

Idempotent, but the first call on a template can be slow while the document is analyzed. Later calls reuse that result and return promptly.

Learn more: Form filling guide

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired>=1 character

Response

Field inventory, values schema and page geometry.
fieldslist of objects
pageBoxeslist of objects
Page size in points, one entry per page.
pageCountinteger-9007199254740991-9007199254740991
detectedboolean
True when the fields were detected rather than read from an existing AcroForm.
schemamap from strings to anyOptional

A JSON Schema describing the values object the fields accept.

templateHashstringOptional

sha256 of the prepared template bytes — save it with the fields to spot a stale curation.

Errors

409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error