API Fill

How to use this docs page

This page is meant to answer one operational stage of the DullyPDF workflow well enough that you can run a controlled test without guessing. Read the sections below, validate the behavior against one representative document, and only then move to the next linked page.

That order matters because most setup failures come from mixing detection, mapping, fill validation, and sharing into one unstructured pass. A narrower review loop keeps troubleshooting faster and makes the template easier to trust once you save it for reuse.

What API Fill is

• API Fill publishes one saved-template snapshot as a hosted backend endpoint that accepts JSON and returns a PDF.
• Each endpoint has its own generated key, schema view, rate limits, monthly request limits, and audit activity.
• API Fill is a server-side runtime. It is different from Search & Fill, which keeps selected record data local in the browser.

Owner manager flow

1. Open a saved template in the workspace.
2. Click API Fill to open the endpoint manager.
3. The manager header includes a Usage Docs button immediately left of the red close control so you can open these API Fill docs in a new browser tab/window without leaving the editor.
4. Create the endpoint from the current saved-template snapshot, then copy the fill URL, public schema URL, POST example, and active key.
5. Rotate or revoke keys from the same manager when credentials need to change.

Payload and fill behavior

• The public schema exposes field names, types, transforms, checkbox rules, and radio group expectations for the frozen template snapshot.
• Public requests must send a top-level data object. Misspelled top-level keys like fields or stict are rejected instead of being ignored.
• The manager examples use strict=true so integration smoke tests fail closed when a caller sends unknown keys.
• Blank strings remain valid scalar values, so callers can intentionally clear a text or date-style field instead of leaving the published default in place.
• Radio groups are resolved deterministically as one selected option key, not as a legacy checkbox-hint side channel.
• API Fill does not reuse the generic workspace materialize endpoint. It is its own hosted path with explicit auth, limits, and audit activity.
• The backend is designed not to store raw submitted record values by default unless a separate operational need is added later.

When to use API Fill instead of Search and Fill

Use Search & Fill when an operator is choosing a row interactively inside the workspace. Use API Fill when another system already has the record data and needs a hosted JSON-to-PDF endpoint for the same saved template.

The template still needs the same review discipline either way: stable naming, correct checkbox and radio behavior, and one real end-to-end validation before the endpoint is treated as production-ready.