Tools

Run a pipeline

Apply 1–10 steps in order and write one new PDF. Step actions: extract, remove, rotate, crop, scale, flatten, labels, watermark, metadata-clear; options as in the matching tools (e.g. {"action":"rotate","options":{"pages":"1","angle":90}}).

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

post/v1/tools/pdf_run_pipeline

Request

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

Request body

inputstring required

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

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.