QR encode

POST /api/qr-encode1 quota unit per call · cache hits free

Generate a QR code as PNG or SVG. Configurable error-correction level, size, and quiet-zone margin.

Generates a QR code from arbitrary text. Output is PNG or SVG. Options: - `text`: what to encode. Often a URL, but anything works. - `errorCorrection`: `L` (7%), `M` (15%, default), `Q` (25%), or `H` (30%). Higher correction takes more space but survives more damage / occlusion. - `size` (default 256): pixel side length for PNG. - `margin` (default 4): the quiet-zone padding (in modules) around the code. Required for reliable scanning.

Inputs

Name	Type	Default	Description
text*	string	—	Text payload to encode (e.g. URL, message).
errorCorrection	enum (L \| M \| Q \| H)	"M"	Error-correction level. L=~7%, M=~15%, Q=~25%, H=~30% recovery.
sizePx	number (0…4096)	256	Minimum SVG dimension in user units. 0 = auto (per-module = 1).
format	enum (svg \| matrix)	"svg"	Output shape. `svg` (default) returns a rendered QR image. `matrix` returns the raw module grid as JSON ({size, modules}) for client-side styling.

Response

Modes: binary, text, 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	`16 KiB` (base64 inflates file payloads ~33% — the limit applies to the decoded bytes).
Max response size	`1 MiB`
Timeout	3s 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 url example.


curl -X POST https://api.xtract.bot/api/qr-encode \
  -H "Content-Type: application/json" \
  -H "Accept: application/octet-stream" \
  -H "X-Account-Id: $XTRACT_ACCOUNT_ID" \
  -H "X-Api-Key: $XTRACT_API_KEY" \
  -d '{
  "text": "https://xtract.bot",
  "errorCorrection": "M",
  "sizePx": 256
}'