Skip to content

Using Skymage

Public Origin Images

Remove the source URL scheme and append the hostname and path after /v1/:

text
Source:  https://example.com/images/product.jpg
Skymage: https://demo.skymage.net/v1/example.com/images/product.jpg

Add transformation parameters as a normal query string:

text
https://demo.skymage.net/v1/example.com/images/product.jpg?w=640&h=640&fit=contain&f=webp&q=82

Skymage defaults schemeless source paths to HTTPS. Origins that resolve to private or reserved network addresses are rejected.

External Storage Images

After connecting Amazon S3 or Bunny Storage in the dashboard, use the storage handle after /v1/ex/:

text
https://demo.skymage.net/v1/ex/product-images/catalog/item-001.jpg?w=480&h=480&fit=cover&f=avif&q=80

Responsive HTML

html
<img
  src="https://demo.skymage.net/v1/example.com/images/hero.jpg?w=960&f=webp&q=82"
  srcset="
    https://demo.skymage.net/v1/example.com/images/hero.jpg?w=480&f=webp&q=82 480w,
    https://demo.skymage.net/v1/example.com/images/hero.jpg?w=960&f=webp&q=82 960w,
    https://demo.skymage.net/v1/example.com/images/hero.jpg?w=1440&f=webp&q=82 1440w
  "
  sizes="100vw"
  width="960"
  height="540"
  alt="Product overview"
>

Common Recipes

Product image without cropping:

text
?w=640&h=640&fit=contain&f=webp&q=84

Fixed-size card thumbnail:

text
?w=480&h=320&fit=cover&p=center&f=avif&q=80

High-density avatar:

text
?w=96&h=96&fit=cover&dpr=2&f=webp&q=80

Grayscale editorial image:

text
?w=1200&filter=grayscale&con=10&f=webp&q=84

Parameter Contract

The generated API reference is the authoritative list of supported parameters, values, and limits. It is produced from the engine catalog and checked on every engine commit.