JSON patch

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

Apply RFC 6902 JSON Patch or RFC 7396 JSON Merge Patch to a JSON document. Atomic — patches that fail mid-way leave the document unchanged.

Applies a patch to a JSON document. Two formats are supported: - `patch`: RFC 6902 JSON Patch — an array of operations (`add`, `remove`, `replace`, `move`, `copy`, `test`) with JSON Pointer paths. - `merge`: RFC 7396 JSON Merge Patch — a partial document whose fields override the corresponding fields in the target. JSON Patch is more powerful (supports test / move / array operations) but more verbose; JSON Merge Patch is simpler but cannot remove fields or operate on arrays cleanly. Application is atomic: if any operation fails, the document is unchanged.

Inputs

Name	Type	Default	Description
document*	string	—	The source JSON document, as a string.
patch*	string	—	The patch (an RFC 6902 array, or an RFC 7396 object), as a string.
format	enum (rfc6902 \| rfc7396)	"rfc6902"	Which patch format the `patch` input uses.

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 rename-field example.


curl -X POST https://api.xtract.bot/api/json-patch \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-Account-Id: $XTRACT_ACCOUNT_ID" \
  -H "X-Api-Key: $XTRACT_API_KEY" \
  -d '{
  "document": "{\"name\":\"alice\",\"age\":30}",
  "patch": "[{\"op\":\"add\",\"path\":\"/displayName\",\"value\":\"alice\"},{\"op\":\"remove\",\"path\":\"/name\"}]",
  "format": "rfc6902"
}'