Compare two DOCX documents or page a durable compare session

Creates a durable compare session when base_document_id and compare_document_id are provided. When compare_id is provided, returns a paginated page from the existing session without creating a new comparison.

POST /documents/compare

Headers

Authorization string Required
Bearer <session token>: the signed-in user’s Scaffold session token.
x-org-id string Required

Body

compare_id string
Durable compare session id. If present, pages the existing session.
base_document_id string
Document/version id where changes should be added. Required when compare_id is omitted.
compare_document_id string
Document/version id that contains the changes. Required when compare_id is omitted.
offset integer
Default 0
page_size integer
Default 10
max_text_chars integer
Default 600
include_artifacts boolean
Default false

Returns

objectKind string
One of compare
compareId string
compare_id string
baseDocumentId string
compareDocumentId string
currentBaseDocumentId string
currentCompareDocumentId string
summary object
decisions object
unresolvedDifferenceIds string[]
differences object[]
Show 12 fields
- ordinal integer
- differenceId string
- kind string
  One of text insert delete formatting
- baseBlockIndex any
- compareBlockIndex any
- baseText string
  The base paragraph's text (for a formatting difference, a preview such as "Run formatting in Base: …"), cut at max_text_chars.
- compareText string
- baseTextTruncated boolean
- compareTextTruncated boolean
- containsFormatting boolean
- formattingChanges object[]
  For a formatting difference, each named property that changed. Empty for other kinds and for compare sessions created before this field existed.
  Show 3 fields
  - property string Required
    One of bold italic underline strike font_size font_name color highlight style alignment indentation spacing
  - base any
    A boolean for a toggle, a short readable string ("12pt", "Heading 2"), or null when unset.
  - compare any
- changeIds string[]
offset integer
pageSize integer
returned integer
totalDifferences integer
hasMore boolean

cURL Node Python

curl -X POST "https://api.scaffoldyourdocs.com/documents/compare" \
  -H "Authorization: Bearer <session token>" \
  -H "x-org-id: org_example" \
  -H "Content-Type: application/json" \
  -d '{"base_document_id":"upload_example","compare_document_id":"upload_example_2"}'

const response = await fetch("https://api.scaffoldyourdocs.com/documents/compare", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <session token>",
    "x-org-id": "org_example",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"base_document_id":"upload_example","compare_document_id":"upload_example_2"})
});

import requests

response = requests.post(
    "https://api.scaffoldyourdocs.com/documents/compare",
    headers={
        "Authorization": "Bearer <session token>",
        "x-org-id": "org_example",
        "Content-Type": "application/json"
    },
    json={"base_document_id": "upload_example", "compare_document_id": "upload_example_2"},
)

Response (shape)

{
  "objectKind": "compare",
  "compareId": "string",
  "compare_id": "string",
  "baseDocumentId": "string",
  "compareDocumentId": "string",
  "currentBaseDocumentId": "string",
  "currentCompareDocumentId": "string",
  "summary": {},
  "decisions": {},
  "unresolvedDifferenceIds": [
    "string"
  ],
  "differences": [
    {
      "ordinal": 0,
      "differenceId": "string",
      "kind": "text",
      "baseBlockIndex": {},
      "compareBlockIndex": {},
      "baseText": "string",
      "compareText": "string",
      "baseTextTruncated": true,
      "compareTextTruncated": true,
      "containsFormatting": true,
      "formattingChanges": [
        {
          "property": "bold",
          "base": {},
          "compare": {}
        }
      ],
      "changeIds": [
        "string"
      ]
    }
  ],
  "offset": 0,
  "pageSize": 0,
  "returned": 0,
  "totalDifferences": 0,
  "hasMore": true
}