VEversionstory

Create Comparison

Compare, diff, or redline documents into a true redline: Word tracked changes, a PDF, or a PDF of the changed pages only.

original is the base (earlier) document and modified the revised (later) one. Word, PDF, DOC and email (.eml/.msg) documents compare with each other; an Excel workbook compares with another workbook and a PowerPoint presentation with another presentation.

Compare the files the user gives as given: pass them even when a Document of that name holds versions, and never hand over a stored redline in their place, since the user's file may have changed since.

Send both documents' bytes as multipart/form-data, in the original and modified fields. The call answers at once with the comparison_id GET /v1/compare/{comparison_id} serves the redline by.

post/v1/compare

Request

  • Base URL
    https://api.versionstory.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.versionstory.com/v1/compare
  • Auth
    HTTP bearer

Headers

X-Customer-Idstring nullable

Id of one of your customers (created in the developer dashboard) to attribute this request's credit usage to. Billing and limits stay organization-wide.

Request body multipart/form-data

originalstring binary required

The base (earlier) document

modifiedstring binary required

The revised (later) document

authorstring nullable

Name to attribute the redline's tracked changes to. Defaults to the revised document's file name.

preserve_track_changesboolean

Keep the tracked changes already in both documents as they are, each under its own author, and add as new tracked changes, under author, only the real differences: original against modified with modified's own tracked changes rejected. For a counterparty's draft that carries their tracked changes: send it as original, and your copy of it, edited with or without Track Changes, as modified. Word documents only; refused for presentations and workbooks. Default false, which compares the documents as if every tracked change in both were accepted.

show_formatting_changesboolean

Track formatting changes (font, size, bold, color, alignment, spacing, table layout) in the redline. Not applied with preserve_track_changes or to a document converted from a PDF. Word documents only. Default false.

track_redline_changesboolean

When an uploaded PDF is a redline (insertions underlined in one color, deletions struck through in another), turn its insertions and deletions into tracked changes in the Word document made from it. Default true. A PDF that is not a redline, and any other kind of document, is unaffected. Applies to the documents this request uploads; a document already in Version Story keeps the choice its upload made.

Response

Successful Response

comparison_idstring required

The comparison's id (cmp_...), which GET /v1/compare/{comparison_id} takes.

redline_file_idstring nullable

Deprecated: use file.file_id, the same id. Absent for a presentation or workbook comparison.

status'processing' required

Changes

No recorded changes to this operation across all 1 revision of this API.