Diff text

POST /api/diff-text1 quota unit per call · cache hits free

Diff two text inputs at line, word, or character granularity. Returns the unified diff plus per-segment add/remove arrays for custom rendering.

Computes the difference between two text inputs and returns both a unified-diff string (the format `git diff` produces) and a structured per-segment array (with `added`, `removed`, `unchanged` flags) so you can render the diff yourself. Granularity options: - `line` (default): treats each newline-terminated string as a single unit. Best for code or structured text. - `word`: tokenizes on whitespace. Best for prose. - `char`: per-character. Best for short strings or when you want fine-grained highlighting. Stats are included: lines added, lines removed, similarity ratio, longest unchanged run.

Inputs

Name	Type	Default	Description
before*	string	—	Original (pre-change) text.
after*	string	—	Modified (post-change) text.
mode	enum (unified \| split \| stats)	"unified"	Output flavor.
granularity	enum (line \| word \| char)	"line"	Granularity for split/stats; ignored for unified.
context	number (0…100)	3	Lines of unchanged context per hunk (unified only).

Response

Modes: json, text. 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	`8 MiB`
Timeout	10s 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 small example.


curl -X POST https://api.xtract.bot/api/diff-text \
  -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": "alpha\nbeta\ngamma\n",
  "after": "alpha\nBETA\ngamma\n",
  "mode": "unified",
  "context": 3
}'