Image perspective warp

POST /api/image-perspective-warp3 quota units per call · cache hits free

Warp an image with a 4-point perspective transform. Specify the four destination corners; the input is stretched into that quad.

Applies a 4-point perspective transform — supply the four `(x, y)` corners of the destination quad, and the input image is stretched to fill it. Useful for "stick this poster onto that wall in a photo" effects, faked-3D thumbnails, and rectifying photographs of rectangular objects taken at an angle. The output canvas is sized to the bounding box of the four destination corners; areas outside the quad are transparent.

Inputs

Name	Type	Default	Description
image*	file	—	Source image bytes.
corners*	string	—	JSON: array of 4 `[x,y]` integer pairs in TL/TR/BR/BL order. Example: "[[10,20],[300,15],[310,210],[5,200]]".
outWidth	number (0…8192)	0	Target width in pixels. 0 = derive from corner geometry (max of top/bottom edge lengths).
outHeight	number (0…8192)	0	Target height in pixels. 0 = derive from corner geometry (max of left/right edge lengths).
format	enum (jpeg \| png)	"jpeg"	Output encoding.
quality	number (1…100)	90	JPEG quality (ignored for PNG 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	3 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	`25 MiB` (base64 inflates file payloads ~33% — the limit applies to the decoded bytes).
Max response size	`25 MiB`
Timeout	30s 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 identity example.

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

curl -X POST https://api.xtract.bot/api/image-perspective-warp \
  -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 '{
  "corners": "[[0,0],[256,0],[256,256],[0,256]]",
  "outWidth": 200,
  "outHeight": 200,
  "image": "'"$IMAGE"'"
}'