Tools

Add page labels

Add page numbers or a footer. Use {page} and {total} in the text.

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

post/v1/tools/pdf_add_page_labels

Request

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

Request body

inputstring required

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

pagesstring

Page numbers or ranges, such as "1, 3-5". Omit for every page.

textstring
position'top' | 'bottom'

Where on the page the label goes.

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.