API reference

The REST API lives under /api/v1 and speaks JSON. Transform URLs are served from your project's image host.

Authentication

Create a key in the dashboard and send it as a bearer token. Keys are scoped to one project.

curl https://api.example.com/api/v1/images \
  -H "Authorization: Bearer pf_live_..."

Transform URLs

Parameter	Description
`w`, `h`	Target width and height in pixels.
`fit`	`cover` (default), `contain`, `fill`, `inside`.
`crop`	`smart`, `face`, `center` or `x,y,w,h`.
`fmt`	`auto`, `avif`, `webp`, `jpeg`, `png`.
`q`	Quality, 1–100. Defaults depend on the format.
`sig`	HMAC-SHA256 of the path and parameters, required when signing is on.

Images

GET/api/v1/images lists source images. DELETE/api/v1/images/{id} purges one from every cache.

Usage

GET/api/v1/usage?from=2026-10-01 returns daily transform counts and bandwidth.

Errors

HTTP/1.1 401 Unauthorized
{
  "error": {
    "code": "missing_api_key",
    "message": "No API key provided. Pass it as 'Authorization: Bearer <key>'."
  }
}

Public endpoints

These need no key: /api/health, /api/v1/status, /api/v1/plans, /api/v1/regions.