SVG to PNG

POST /api/svg-to-png2 quota units per call · cache hits free

Render an SVG to a PNG at the requested size. Useful for thumbnails, OG images, app icons, anything that needs a bitmap of an SVG.

Renders an SVG document to a PNG bitmap at the requested size. Inputs: - `svg`: the SVG source (text or bytes). - `width` / `height`: target dimensions in pixels. If only one is set, the other is derived from the SVG aspect ratio. - `background` (default transparent): a hex colour to fill the canvas before rendering. Useful when the SVG itself has no background and you want a non-transparent PNG. Use cases: thumbnail generation for icons, OG-image rendering for share-cards, baked-in fallbacks for older browsers.

Inputs

Name	Type	Default	Description
svg*	file	—	SVG markup (UTF-8 bytes).
width	number (1…16384)	—	Output width in pixels. Mutually exclusive with `height` and `scale`.
height	number (1…16384)	—	Output height in pixels. Mutually exclusive with `width` and `scale`.
scale	number (0.05…32)	—	Zoom factor (1 = native size, 2 = double, 0.5 = half). Mutually exclusive with `width` and `height`.
background	string	—	CSS colour for the background (e.g. `#fff`, `rgba(0,0,0,0.5)`). Default transparent — preserves SVG transparency.
dpi	number (1…600)	96	DPI for physical-unit conversion (mm/pt → px). Default 96 (web-standard). Use 300 for print-quality output.

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 call	2 units 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	`8 MiB` (base64 inflates file payloads ~33% — the limit applies to the decoded bytes).
Max response size	`32 MiB`
Timeout	60s 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 native-size example.

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

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