JSON diff

POST /api/json-diff1 quota unit per call · cache hits free

Diff two JSON documents and return the set of differences as JSON Patch operations (RFC 6902) or a structured changes array.

Computes the difference between two JSON documents and returns the changes in two forms: - A JSON Patch (RFC 6902) that, applied to the first input, produces the second. Use this for downstream patching. - A structured `changes` array (`{path, op, oldValue, newValue}`) easier to display in a UI. Useful for auditing config changes, building change-log feeds, or implementing a "compare snapshots" feature.

Inputs

Name	Type	Default	Description
before*	string	—	The original JSON document, as a string.
after*	string	—	The new JSON document, as a string.
includeFromValue	boolean	false	Annotate each replace op with what it replaced (non-standard).

Response

Modes: json. Cache: yes (24h TTL).

Every response carries x-cache (HIT / MISS / BYPASS), x-cache-signature (stable across identical inputs), and the rate-limit headers listed below.

Quota & limits

Cost per call	1 unit against the 10,000-unit monthly quota. Cache hits are free — only cache misses decrement.
Burst limit	200 requests per rolling minute, shared across all tools.
Max request size	`4 MiB` (base64 inflates file payloads ~33% — the limit applies to the decoded bytes).
Max response size	`4 MiB`
Timeout	5s wall clock.
Rate-limit headers	`X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Burst-Limit` on every response; `X-Quota-Warning` once 80% of the monthly quota is spent; `Retry-After` on 429s.

Errors

Errors are JSON with an error string; schema failures add a details object (Zod's flattened field errors).

Status	When	Body
400	Input fails the tool's schema (wrong type, missing required field, malformed base64) or the file bytes can't be parsed as the expected format.	{ "error": "invalid inputs", "details": { "fieldErrors": { … } } }
401	Missing or invalid X-Api-Key / X-Account-Id headers (or no session when called from the browser).	{ "error": "unauthorized" }
404	Unknown tool id, or calling /api/* on the website hostname instead of api.xtract.bot.	{ "error": "not found" }
413	Request body over the tool's max request size, or an image header declaring more megapixels than the tool's pixel budget.	{ "error": "…exceeds maxRequestBytes…" }
415	Content-Type isn't application/json on the json-body transport.	{ "error": "unsupported content-type; expected application/json" }
429	Monthly quota or the 200/min burst limit exhausted. Check Retry-After and the X-RateLimit-* headers.	{ "error": "monthly quota exceeded", "monthRemaining": 0, … }
5xx	Conversion engine failure. Safe to retry; if it persists, the input is hitting a bug — please report it.	{ "error": "…" }

Code samples

Built from the trivial-rename example.


curl -X POST https://api.xtract.bot/api/json-diff \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-Account-Id: $XTRACT_ACCOUNT_ID" \
  -H "X-Api-Key: $XTRACT_API_KEY" \
  -d '{
  "before": "{\"name\":\"alice\",\"age\":30}",
  "after": "{\"name\":\"alice\",\"age\":31}",
  "includeFromValue": false
}'