Guides

Compare PDFs API

Highlight every change between two versions. Tool id compare-pdf; runs on our servers through POST /tasks.

At a glance#

PropertyValue
Tool idcompare-pdf
Accepts.pdf
Files per taskAt least 2; at most 2 on Pro, 2 on Business
Largest file500 MB on Pro, 500 MB on Business
PlanPro or Business (other plans answer 402 LIMIT_PRO_TOOL)
ResultPDF

Accepted MIME types: application/pdf.

Options#

Put options in data.options. Missing options take their defaults; a value outside the allowed range answers 400 (see Errors).

OptionTypeDefaultAllowed valuesRequired
reportstring"full"one of: full, textOnly, overlayOnlyNo
overlayPageAnumber—1 to 100000No
overlayPageBnumber—1 to 100000No

Build a request#

Upload the files as files[] and the tool and options as a JSON string in data. Change the options below and the request follows; only values that differ from the defaults are sent. Set MACAAW_API_KEY to a sandbox key while you build (see Quickstart).

Default "full"

Sent options: {}

curl https://macaaw.com/public/v1/tasks \
  -H "Authorization: API-Key $MACAAW_API_KEY" \
  -F "files[]=@report-1.pdf;type=application/pdf" \
  -F "files[]=@report-2.pdf;type=application/pdf" \
  -F 'data={"tool":"compare-pdf","options":{}}'
201 Created
{
  "id": "3f0c9a52-6d1e-4c8b-a1f4-0e7d2b9c8a11",
  "tool": "compare-pdf",
  "status": "task.queued",
  "state": "queued",
  "error": null,
  "input_size": 4831022,
  "output_size": null,
  "output_files": null,
  "stats": null,
  "sandbox": false,
  "date_created": "2026-10-30T11:35:00.000000Z",
  "date_completed": null,
  "expires_at": null
}

Then poll the task or wait for the task_completed webhook, and download the result. When a task produces several files, the download is a ZIP.

Sandbox tasks are free and never counted: they process at most 5 pages and their output is stamped. Live tasks count against your plan like tasks on the website.

Try it without code on the website: Compare PDFs.

Compare PDFs API · Macaaw API