Document comparison

Document comparison

ParseRail compares two versions of a contract or document and returns every material change, what it means, and the risk it carries.

Cost: 15 credits ($0.15) — charged only on success.

Accepts async: true for long documents — see the Async & webhooks guide.

post/v1/compare

Request

  • Base URL: https://api.thecompound.tech
  • URL: https://api.thecompound.tech/v1/compare
  • Auth: HTTP bearer

Headers

ParseRail-Dry-Run'1' | 'true'

Send 1 to dry-run the call. ParseRail runs auth, the throttle, body validation and the balance precheck. It returns 200 with the cost and the status a live call would get. No model runs and nothing is charged, so a key with a zero balance works. Dry runs count against the per-key rate limit.

Idempotency-Keystring

Key for one logical operation. Same body replays the result for 24 hours; a different body with the same key returns 409.

Request body

asyncboolean

The endpoint processes the request outside the request/response cycle. It returns 202 with a jobId instead of the result. Poll GET /v1/jobs/{id}, or supply callbackUrl.

callbackUrlstring uri

The endpoint POSTs the finished job to a public https URL. The endpoint signs the request with your account's webhook secret, as described in the Async & webhooks guide. The endpoint ignores the URL unless async is true.

Example request

{
  "a": {
    "file": {
      "mimeType": "application/pdf"
    }
  },
  "b": {
    "file": {
      "mimeType": "application/pdf"
    }
  }
}

Response

The call succeeded. The response contains result fields and a usage envelope. With ParseRail-Dry-Run: 1 the body is a DryRun object instead.

OR

Changes

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