Skip to content
Keenpix docs
Getting started

Quickstart

Your first optimized image in two minutes — no SDK, no API key.

Keenpix is just an HTTP endpoint, so the fastest integration is a plain <img> tag.

1. Allow your source host

Open Settings → Security → Allowed hosts for your project and add the hostname your images come from (e.g. cdn.example.com). Keenpix refuses to fetch from any host that isn't on the list — an empty allowlist blocks every request. This is the entire access model for transform URLs: no API key required.

Find your project id

It's under Settings → General → Project ID. You pass it as project= in every URL.

2. Point an <img> at the endpoint

<img
  src="https://keenpix.example.com/img/https://cdn.example.com/hero.jpg?project=YOUR_ID&w=1200&fmt=auto"
  sizes="100vw"
  loading="lazy"
  decoding="async"
  alt="Hero"
/>

The first request is a cache MISS (Keenpix fetches + transforms the original); every later request for the same parameters is a HIT served straight from disk.

3. Tune the output

Add query parameters to resize and re-encode:

ParamExampleEffect
ww=1200Resize to 1200px wide
qq=80Quality 30–100 (default from settings)
fmtfmt=autoNegotiate AVIF/WebP/JPEG from Accept; use fmt=svg explicitly for optimized SVG output
dprdpr=2Render at 2× for retina screens

See the API reference for the full list, or jump to your framework guide.

On this page