Quickstart
Call the REST API directly from cURL, Python, or JavaScript — no custom PyPI package required.
STEP 02
POST /v1/generate
Pick a finish (crisp_vibrant or anodized_muted), palette, and mode.
STEP 03
Fetch from cdn_url
Download your QHD PNG/WebP or call POST /v1/batch for a dataset ZIP with JSON sidecars.
Endpoints Reference
All authenticated endpoints accept Authorization: Bearer sk-....
| Method & Path | Purpose |
|---|---|
| POST /v1/generate | Generate a single 2560×1440 QHD surface (PNG/WebP) |
| POST /v1/batch | Queue 1–10,000 images packaged into a ZIP with JSON sidecars |
| GET /v1/jobs/{job_id} | Poll batch progress and retrieve final cdn_url |
| GET /v1/storage | List active files, pin status, and ring-buffer quota usage |
| PATCH /v1/storage/{file_id}/pin | Pin/unpin a file to protect it from FIFO eviction |
| DELETE /v1/storage/{file_id} | Delete a file and immediately reclaim quota |