Tools

Fill a PDF form

Fill form fields by name (pdf_info lists them): text fields take text, check boxes true or false, choices one of their options. With flatten, the filled values become part of the page and can no longer be edited.

Same tool as the MCP server's pdf_fill_form. Runs before responding; for long work, POST /v1/jobs instead.

post/v1/tools/pdf_fill_form

Request

  • Base URL: http://127.0.0.1:7341
  • URL: http://127.0.0.1:7341/v1/tools/pdf_fill_form
  • Auth: HTTP bearer

Request body

inputstring required

Path to a PDF inside an allowed folder (absolute, or relative to the first allowed folder).

valuesobject required

Field name → value, such as {"Name": "Ada Lovelace", "Agree": true}.

flattenboolean

Make the filled values part of the page (no longer editable).

outputstring required

Path for the new PDF, inside an allowed folder. Must not exist yet; superPDF never overwrites files.

Response

The result. Any new files are written inside the allowed folders.

outputstring required
pagesinteger required
bytesinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.