Zum Inhalt
HALOWERK

Medienwerk

pdf fill

Called without "fields" it inspects: every AcroForm field of the PDF comes back with its name, type, current value, whether it is required or read-only, the permitted options for dropdowns, radio groups and list boxes, and the character limit of text fields. Called with "fields" it fills exactly those and returns the resulting PDF as base64, together with what each field held before and after.

POST https://medien.halowerk.com/v1/pdf-fill

Eingaben

Felder des veröffentlichten Eingabeschemas
FeldTypPflichtBeschreibung
sourceobjectJaThe PDF. Either url or content_base64.
fieldsobjectNeinField name to value. Text fields take strings, check boxes true/false, dropdowns and radio groups one of their options, list boxes an array. Omit entirely to only inspect the form.
flattenbooleanNeinBake the values into the page content. Irreversible: the form is gone afterwards.
return_pdfbooleanNeinReturn the filled PDF as base64. Set false if only the field report is wanted.
ignore_encryptionbooleanNeinTry to open a PDF that declares encryption. Filling usually still fails; off by default so the reason stays visible.
Vollständiges Eingabeschema anzeigen
{
  "type": "object",
  "required": [
    "source"
  ],
  "additionalProperties": false,
  "properties": {
    "source": {
      "type": "object",
      "additionalProperties": false,
      "description": "The PDF. Either url or content_base64.",
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 2048,
          "description": "Public http(s) URL of the PDF."
        },
        "content_base64": {
          "type": "string",
          "maxLength": 12000000,
          "description": "The PDF inline, base64."
        },
        "filename": {
          "type": "string",
          "maxLength": 260
        }
      }
    },
    "fields": {
      "type": "object",
      "description": "Field name to value. Text fields take strings, check boxes true/false, dropdowns and radio groups one of their options, list boxes an array. Omit entirely to only inspect the form.",
      "additionalProperties": {
        "type": [
          "string",
          "number",
          "boolean",
          "array",
          "null"
        ]
      }
    },
    "flatten": {
      "type": "boolean",
      "default": false,
      "description": "Bake the values into the page content. Irreversible: the form is gone afterwards."
    },
    "return_pdf": {
      "type": "boolean",
      "default": true,
      "description": "Return the filled PDF as base64. Set false if only the field report is wanted."
    },
    "ignore_encryption": {
      "type": "boolean",
      "default": false,
      "description": "Try to open a PDF that declares encryption. Filling usually still fails; off by default so the reason stays visible."
    }
  }
}

Originalschema öffnen

Veröffentlichtes Eingabebeispiel

{
  "source": {
    "url": "https://example.com/antrag.pdf"
  }
}

Ergebnis & Dokumentation

Maschinenlesbare Dokumentation dieses Hubs

Quelle dieser Seite: der veröffentlichte HALOWERK-Katalog. Stand: 2026-11-01, 15:19 UTC.

Weitere Endpunkte dieses Hubs

Alle Endpunkte dieses Hubs →