Ouput

A mandatory operation when requesting an image.

This provides the format of the generated image along with additional (optional) transformations.

Format

This mandatory and dictates which optional output operations can be applied.

The format property should be one of jpeg, webp, tiff, avif or png.

jpeg

progressive

Use progressive (interlace) scan.

compressionLevel

Zlib compression level, 0 (fastest, largest) to 9 (slowest, smallest) (optional, default 6)

adaptiveFiltering

Use adaptive row filtering (optional, default false)

palette

Quantise to a palette-based image with alpha transparency support (optional, default false)

quality

Use the lowest number of colours needed to achieve given quality, sets palette to true (optional, default 100)

colours

Maximum number of palette entries, sets palette to true (optional, default 256)

colors

Alternative spelling of options.colours, sets palette to true (optional, default 256)

dither

Level of Floyd-Steinberg error diffusion, sets palette to true (optional, default 1.0)

force

Force PNG output, otherwise attempt to use input format (optional, default true)

webp

quality

quality, integer 1-100 (optional, default 80)

alphaQuality

quality of alpha layer, integer 0-100 (optional, default 100)

lossless

Use lossless compression mode (optional, default false)

nearLossless

Use near_lossless compression mode (optional, default false)

smartSubsample

Use high quality chroma subsampling (optional, default false)

reductionEffort

Level of CPU effort to reduce file size, integer 0-6 (optional, default 4)

pageHeight

Page height for animated output

force

Force WebP output, otherwise attempt to use input format (optional, default true)

tiff

quality

quality, integer 1-100 (optional, default 80)

force

Force TIFF output, otherwise attempt to use input format (optional, default true)

compression

Compression options: lzw, deflate, jpeg, ccittfax4 (optional, default 'jpeg')

predictor

Compression predictor options: none, horizontal, float (optional, default 'horizontal')

pyramid

Write an image pyramid (optional, default false)

tile

Write a tiled tiff (optional, default false)

tileWidth

horizontal tile size (optional, default 256)

tileHeight

vertical tile size (optional, default 256)

xres

horizontal resolution in pixels/mm (optional, default 1.0)

yres

vertical resolution in pixels/mm (optional, default 1.0)

bitdepth

reduce bitdepth to 1, 2 or 4 bit (optional, default 8)

avif

quality

quality, integer 1-100 (optional, default 80)

lossless

Use lossless compression (optional, default false)

speed

CPU effort vs file size, 0 (slowest/smallest) to 8 (fastest/largest) (optional, default 5)

chromaSubsampling

Set to '4:4:4' to prevent chroma subsampling otherwise

png

This can be added at the end of the process url as /output~format:png.

progressive

Use progressive (interlace) scan.

compressionLevel

Zlib compression level, 0 (fastest, largest) to 9 (slowest, smallest) (optional, default 6)

adaptiveFiltering

Use adaptive row filtering (optional, default false)

palette

Quantise to a palette-based image with alpha transparency support (optional, default false)

quality

Use the lowest number of colours needed to achieve given quality, sets palette to true (optional, default 100)

colours

Maximum number of palette entries, sets palette to true (optional, default 256)

colors

Alternative spelling of options.colours, sets palette to true (optional, default 256)

dither

Level of Floyd-Steinberg error diffusion, sets palette to true (optional, default 1.0)

force

Force PNG output, otherwise attempt to use input format (optional, default true)