Documentation

API Reference

Transform API

The Transfrom API allows you to resize, convert and crop images instantly on the fly.

See the API Basics for details on how to call the API using the options defined below.

Options

Name Values Description
w Integer

The width of the new image. If not specified, the width will be calculated from the h parameter according to the images aspect ratio.

Feature
w_272,h_200
Feature
w_104

h Integer

The height of the new image. If not specified, the height will be calculated from the w parameter according to the images aspect ratio.

Feature
h_200
Feature
w_104,h_100

c XxY-WxH

The crop region of the image. Specified as an X,Y coordinate from the top left corner and W and H as the integer width and height.

Feature
c_1200x500-1100x500,h_200
Feature
c_1400x750-200x200

f jpeg, png, gif, tiff, webp, jxr

The output format of the image. If not specified, the original format will be used.

Feature
w_104,f_png
Feature
w_104,f_gif
Feature
w_104,f_jpeg

t fit, auto

The tranformation mode. If not specified, "auto" is used.

  • fit - Resize the image to fit within the w and/or h while maintaining original aspect ratio.
  • auto - Auto-crop around interesting focal point.
Feature
w_100,h_200,t_fit
Feature
w_100,h_200,t_auto
q Integer,low,lossless

Set the quality for the resulting image format.

  • jpeg - The jpeq quality [0-100]. Default is 85.
  • png - The png compression factor [0-100]. Default is 55.
  • tiff - The tiff compression factor [0-100]. Default is 55.
  • gif - The gif compression factor [0-100]. Default is 55.
Feature
w_200,q_10
Feature
w_200,q_50
Feature
w_200,q_90
s none, low, med, high

Apply an unsharp mask to the image. If not specified, "low" is used.

Feature
w_300,s_none
Feature
w_300,s_high
e

Keep the original exif data. If not specified, exif data is removed.

Feature
w_300,e
Feature
w_300
n

Prevent upscaling. If not specified, images will be upscaled.

Feature
w_3000,n
z

Compression level for lossless file formats (png).

Feature
w_300,z_90
Feature
w_300,z_10