Skip to content
POST AI agent ready /v1/json/diff

JSON Diff API - Free Compare JSON Documents

Compares two JSON documents and produces a structured diff. Each change is classified as an addition, removal, or modification with the path, old value, and new value. Useful for auditing configuration changes or tracking API response drift.

Parameters

stringrequired

The original JSON document (before).

stringrequired

The modified JSON document (after).

Code examples

curl -X POST https://api.botoi.com/v1/json/diff \
  -H "Content-Type: application/json" \
  -d '{"original":"{\"name\":\"botoi\",\"version\":1}","modified":"{\"name\":\"botoi\",\"version\":2,\"beta\":true}"}'

When to use this API

Audit configuration changes

Compare the old and new versions of a JSON config file to produce a human-readable changelog entry.

Track API response drift

Periodically snapshot a third-party API response and diff it against the previous snapshot to detect breaking changes.

Review feature flag updates

Diff feature flag JSON before and after a deploy to confirm only the intended flags changed.

Frequently asked questions

What format does the diff output use?
The response uses JSON Patch-style paths (e.g., /name/first) with change types: "added", "removed", and "changed".
Does the diff handle nested objects and arrays?
Yes. The diff recurses into nested objects and arrays, reporting changes at every depth level.
Can I diff two JSON files that have different key ordering?
Yes. Key order does not matter. The diff compares values by key path, not by position in the string.
Is there a limit on the size of the JSON documents?
Each document can be up to 512 KB. For larger comparisons, run the diff locally.

Get your API key

Free tier includes 5 requests per minute with no credit card required. Upgrade for higher limits.

Sign up free View full docs