Skip to content

Papermint for developers

Run every Papermint tool programmatically over a simple REST API — upload, poll, download.

API keys

Sign in to create API keys. Jobs run through a key count against your plan's limits.

1 · Submit a job

POST multipart form data to /api/jobs with your key in X-Api-Key. tool is any tool id (e.g. compress-pdf, merge-pdf, ocr-pdf); options is the tool's JSON options.

curl -X POST http://127.0.0.1:8080/api/jobs \
  -H "X-Api-Key: pm_live_..." \
  -F "tool=compress-pdf" \
  -F 'options={"level":"recommended"}' \
  -F "files=@report.pdf"

# → {"jobId":"a1b2c3..."}

2 · Poll status

curl http://127.0.0.1:8080/api/jobs/a1b2c3...

# → {"job":{"status":"processing","progress":62,"stage":"Optimising page 3 of 8"}}
# → {"job":{"status":"done","result":{"name":"report_compressed.pdf",
#      "size":184223,"downloadUrl":"/api/download/a1b2c3.../<token>"}}}

3 · Download the result

curl -L -o result.pdf http://127.0.0.1:8080/api/download/a1b2c3.../<token>

Download links are HMAC-signed and expire with the file (24 h on an authenticated key). Your plan's file-size, batch and daily-job limits apply to API traffic exactly as in the app.

Tool ids

merge-pdf · split-pdf · organize-pdf · rotate-pdf · remove-pages · extract-pages · scan-to-pdf · compress-pdf · repair-pdf · ocr-pdf · jpg-to-pdf · jpeg-to-pdf · png-to-pdf · word-to-pdf · powerpoint-to-pdf · excel-to-pdf · html-to-pdf · pdf-to-jpg · pdf-to-word · pdf-to-powerpoint · pdf-to-excel · pdf-to-pdfa · pdf-to-xml · validate-pdf · make-accessible · e-invoice · digital-signature · edit-pdf · read-pdf · fill-form · extract-form-data · document-info · page-numbers · n-up · header-footer · watermark-pdf · crop-pdf · redact-pdf · compare-pdf · sign-pdf · protect-pdf · unlock-pdf