xtract.bot

POST /api/png-to-avif3 quota units per call · cache hits free

Convert a PNG to AVIF — typically 50% smaller than equivalent JPEG at the same quality. Configurable quality / speed tradeoff.

Re-encodes a PNG as AVIF. AVIF is the most efficient modern image format — typically 50% smaller than equivalent JPEG at the same perceptual quality. Quality is 1–100 (default 50). Higher quality preserves more detail but produces larger files. The encoder also exposes a `speed` tradeoff: higher numbers encode faster but produce larger output. Use AVIF when you control both ends (your CDN serves it, your browsers decode it). For broader compatibility, WebP and JPEG remain better choices.

Inputs

NameTypeDefaultDescription
image*fileInput PNG bytes.
qualitynumber (0…100)50AVIF visual quality 0–100 (50 ≈ JPEG q80). Ignored when lossless=true.
effortnumber (0…10)4Encoder effort 0–10. Higher = smaller file, more CPU.
losslessbooleanfalseWhen true, encode losslessly. `quality` is ignored.

Response

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

Large outputs stream: responses over the 4 MiB cache limit are piped through as they are produced instead of buffered. They carry x-cache-skip: size and are never cached — identical follow-up calls recompute.

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 call3 units against the 10,000-unit monthly quota. Cache hits are free — only cache misses decrement.
Burst limit200 requests per rolling minute, shared across all tools.
Max request size16 MiB (base64 inflates file payloads ~33% — the limit applies to the decoded bytes).
Max response size32 MiB
Timeout60s wall clock.
Rate-limit headersX-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).

StatusWhenBody
400Input 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": { … } } }
401Missing or invalid X-Api-Key / X-Account-Id headers (or no session when called from the browser).{ "error": "unauthorized" }
404Unknown tool id, or calling /api/* on the website hostname instead of api.xtract.bot.{ "error": "not found" }
413Request body over the tool's max request size, or an image header declaring more megapixels than the tool's pixel budget.{ "error": "…exceeds maxRequestBytes…" }
415Content-Type isn't application/json on the json-body transport.{ "error": "unsupported content-type; expected application/json" }
429Monthly quota or the 200/min burst limit exhausted. Check Retry-After and the X-RateLimit-* headers.{ "error": "monthly quota exceeded", "monthRemaining": 0, … }
5xxConversion engine failure. Safe to retry; if it persists, the input is hitting a bug — please report it.{ "error": "…" }

Code samples

Built from the default example.

# Download or substitute the example input:
#   curl -O https://xtract.bot/examples/image-png-to-webp/sample.png
IMAGE=$(base64 -w0 < sample.png)

curl -X POST https://api.xtract.bot/api/png-to-avif \
  -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 '{
  "image": "'"$IMAGE"'"
}'