Developers

API documentation

Everything you need to call pixpoo directly from your product — authentication, core endpoints, quotas, and a reference page for every transform.

Authentication

Every request to /v1/images/* and /v1/upload/* requires an x-api-key header. Find your key on your dashboard after signing up.

curl https://api.pixpoo.com/v1/images/transform \
  -H "x-api-key: pxp_xxxxxxxx" \
  -F file=@photo.jpg \
  -F width=1200

Core endpoints

POST
/v1/images/transform
Single-image transform. Returns the processed image as raw bytes.
POST
/v1/images/transform/json
Same as above, returns JSON with a base64 data URL instead — used by the web editor.
GET
/v1/images/usage
Current month's transform count against your plan quota.
POST
/v1/upload/bulk
Queue up to 50 files for background processing with one request.
GET
/v1/upload/bulk/:batchId
Poll a bulk batch for progress and per-file results.

Quotas

Each successful transform — single or as part of a bulk batch — counts as one unit against your monthly plan quota. Exceeding it returns a 429. Everything is free while pixpoo is in beta; paid tiers with higher limits are coming later.

Transform reference

Resize

The resized image, re-encoded at the requested quality.

Crop

The extracted region as a new image.

Compress

The re-encoded image plus X-Pixpoo-Original-Size / X-Pixpoo-Output-Size response headers.

Convert

The same image re-encoded in the requested format.

Background removal

A transparent PNG with the background removed.

Upscale

The upscaled image at 2x or 4x the original dimensions.

Watermark

The image with the watermark composited onto it.