Skip to content
HALOWERK

Formatwerk

pdf form schema

Walks the AcroForm field tree with pdf-lib 1.17.1 (ISO 32000-2 §12.7.4, inheritable FT/Ff/V/DV/Opt/MaxLen) and maps every terminal field to a schema property named with its fully qualified name: text fields to strings with maxLength, number-formatted fields to numbers, checkboxes to booleans (or their on/Off states), radio groups and combo boxes to enums of export values (radio states resolved through /Opt indices), editable combos to strings with examples, multi-select lists to arrays with.

POST https://format.halowerk.com/v1/pdf-form-schema

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
content_base64stringNoThe PDF as base64 (a data: prefix and whitespace are tolerated); at most 10 MB decoded.
urlstringNoPublic http(s) URL of the PDF (at most 10 MB). Private, local and reserved addresses are refused.
nestedbooleanNoNest properties by the dot-separated name segments instead of flat fully qualified names.
checkbox_asstringNoRepresent checkboxes as booleans or as an enum of their appearance states.
include_valuesbooleanNoPut the current field values into "default".
titlestringNoTitle of the generated schema.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "content_base64": {
      "type": "string",
      "minLength": 8,
      "maxLength": 13981016,
      "description": "The PDF as base64 (a data: prefix and whitespace are tolerated); at most 10 MB decoded."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "Public http(s) URL of the PDF (at most 10 MB). Private, local and reserved addresses are refused."
    },
    "nested": {
      "type": "boolean",
      "default": false,
      "description": "Nest properties by the dot-separated name segments instead of flat fully qualified names."
    },
    "checkbox_as": {
      "type": "string",
      "enum": [
        "boolean",
        "enum"
      ],
      "default": "boolean",
      "description": "Represent checkboxes as booleans or as an enum of their appearance states."
    },
    "include_values": {
      "type": "boolean",
      "default": true,
      "description": "Put the current field values into \"default\"."
    },
    "title": {
      "type": "string",
      "maxLength": 200,
      "description": "Title of the generated schema."
    }
  }
}

Open original schema

Published input example

{
  "content_base64": "JVBERi0xLjcKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIvQWNyb0Zvcm08PC9GaWVsZHNbNCAwIFIgNSAwIFJdPj4+PgplbmRvYmoKMiAwIG9iago8PC9UeXBlL1BhZ2VzL0tpZHNbMyAwIFJdL0NvdW50IDE+PgplbmRvYmoKMyAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDIgMCBSL01lZGlhQm94WzAgMCAzMDAgMjAwXS9Bbm5vdHNbNCAwIFIgNSAwIFJdPj4KZW5kb2JqCjQgMCBvYmoKPDwvVHlwZS9Bbm5vdC9TdWJ0eXBlL1dpZGdldC9GVC9UeC9UKG5hbWUpL1RVKEZ1bGwgbmFtZSkvTWF4TGVuIDQwL0ZmIDIvUmVjdFsyMCAxNTAgMjIwIDE2OF0vUCAzIDAgUj4+CmVuZG9iago1IDAgb2JqCjw8L1R5cGUvQW5ub3QvU3VidHlwZS9XaWRnZXQvRlQvQ2gvVChjb3VudHJ5KS9GZiAxMzEwNzIvT3B0WyhERSkoQVQpKENIKV0vVihERSkvRFYoREUpL1JlY3RbMjAgMTIwIDgwIDEzOF0vUCAzIDAgUj4+CmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA4NyAwMDAwMCBuIAowMDAwMDAwMTM4IDAwMDAwIG4gCjAwMDAwMDAyMjMgMDAwMDAgbiAKMDAwMDAwMDM0MSAwMDAwMCBuIAp0cmFpbGVyCjw8L1NpemUgNi9Sb290IDEgMCBSPj4Kc3RhcnR4cmVmCjQ3MwolJUVPRgo="
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub →