xtract.bot
POST /api/regex-replace

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

NameTypeDefaultDescription
pattern*stringRegex pattern (without slashes).
replacement*stringReplacement string. Supports `$&`, `$1`, `$<name>`, `$$`.
text*stringText to operate on.
flagsstring""Regex flags (e.g. `i`, `im`, `iu`). `g` is added unless `firstOnly` is true.
firstOnlybooleanfalseReplace only the first match instead of all.

Response

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

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"
}'