compare_documents
Compare two DOCX documents and produce a tracked-changes output document that marks all differences between them.
You can use this tool in two modes:
- Standalone comparison — provide
original_file_pathandrevised_file_pathto compare any two files. - Session comparison — provide
file_pathto compare the current in-memory session state against the original file that was loaded.
The output document uses Word’s native tracked-changes format. Open it in any Word-compatible application to review, accept, or reject changes.
Path to the original DOCX file. Use with
revised_file_path for standalone comparison.Path to the revised DOCX file. Use with
original_file_path for standalone comparison.Path to the DOCX file. Use instead of
original_file_path + revised_file_path to compare session edits against the original.Destination path for the tracked-changes DOCX output.
Author name attributed to the tracked changes in the output.
Comparison engine to use. One of
auto or atomizer.extract_revisions
Extract tracked changes from a document as structured JSON. Each entry includes before and after text for the affected paragraph, revision details, and any associated comments. Supports pagination for documents with many revisions.
Hints: readOnly — does not modify the document.
Path to the DOCX file.
0-based offset for pagination. Use the offset returned in the previous response to fetch the next page.
Maximum number of revision entries to return per page. Accepted range: 1–500.