xtract.bot

POST /api/heic-to-webp2 quota units per call · cache hits free

Convert HEIC / HEIF (the iPhone capture format) to WebP. Configurable quality, optional lossless mode, edge-cached.

Takes an HEIC or HEIF image and returns the same picture as WebP. WebP at quality 75 is roughly the perceptual equivalent of JPEG at quality 85 with 25-35% smaller files — a useful default for serving images to modern browsers. Set `lossless: true` for a pixel-perfect round-trip (the HEIC itself is still lossy upstream, but no further loss is added). Animated HEIC sequences are not supported — only the primary image is converted. Limits to be aware of: - Maximum image size: 8 megapixels. - iPhone tile-grid captures (full-resolution photos with the HDR gain map) are rejected with a clear error pointing you to re-export the photo at a lower resolution first.

Inputs

NameTypeDefaultDescription
image*fileHEIC or HEIF image bytes.
qualitynumber (1…100)75WebP quality 1–100. Default 75. Ignored when `lossless` is true.
losslessbooleanfalseLossless WebP encode. Slower and larger.

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 call2 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 size25 MiB (base64 inflates file payloads ~33% — the limit applies to the decoded bytes).
Max response size25 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/heic-to-jpeg/sample.heic
IMAGE=$(base64 -w0 < sample.heic)

curl -X POST https://api.xtract.bot/api/heic-to-webp \
  -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"'"
}'