export_comparison_pdf
Export a completed document comparison as a PDF and get a temporary download URL. Optionally wait for completion, pick a language, and include unchanged content.
Instructions
Export a finished comparison as a PDF report and return a temporary download URL (valid for about 5 minutes). With wait=true (default) it polls the export job every 2 seconds for up to 3 minutes and returns { jobId, status: "completed", downloadUrl }. With wait=false it returns { jobId, status } immediately; call again later or poll the REST endpoint to fetch the URL. The comparison must have status="ready". Free workspaces get a watermarked PDF; workspaces with credits export without watermark. Does not consume credits.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"comparison_id": "<comparison_id>"
},
"name": "export_comparison_pdf"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| wait | No | Poll until the export completes (up to 3 minutes) and return the downloadUrl | |
| locale | No | Language for the report labels | en |
| comparison_id | Yes | The comparison UUID | |
| include_unchanged | No | Include unchanged content in the PDF report, not only the changes |