Regex replace

POST /api/regex-replace1 quota unit per call · cache hits free

Find-and-replace text with a JavaScript-style regex. Supports capture groups in the replacement (`$1`, `$2`, …), the `g`/`i`/`m`/`s`/`u` flags, and a count cap.

Applies a regex find-and-replace to the input text. The pattern is JavaScript-flavoured (the same engine your browser uses), so all the usual constructs work: character classes, capture groups, lookaround, named groups, `{n,m}` quantifiers. The replacement supports backreferences to capture groups (`$1`, `$2`, …, `$<name>`). The flags string accepts `g` (global), `i` (case-insensitive), `m` (multi-line `^/$`), `s` (`.` matches newlines), and `u` (Unicode). A `count` cap is available — useful when you only want to replace the first N matches.

Inputs

Name	Type	Default	Description
pattern*	string	—	Regex pattern (without slashes).
replacement*	string	—	Replacement string. Supports `$&`, `$1`, `$<name>`, `$$`.
text*	string	—	Text to operate on.
flags	string	""	Regex flags (e.g. `i`, `im`, `iu`). `g` is added unless `firstOnly` is true.
firstOnly	boolean	false	Replace only the first match instead of all.

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	`4 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 phone example.


curl -X POST https://api.xtract.bot/api/regex-replace \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-Account-Id: $XTRACT_ACCOUNT_ID" \
  -H "X-Api-Key: $XTRACT_API_KEY" \
  -d '{
  "pattern": "(\\d{3})(\\d{3})(\\d{4})",
  "replacement": "$1-$2-$3",
  "text": "Call 0212345678 or 0398765432 today.",
  "flags": "g"
}'