Documentation

Image URL API Reference

The imgix URL API is the heart of the service. By adding these parameters to your image URLs, you can enhance, resize and crop images, compress them and change format for better performance, create complex compositions, and extract useful metadata. These operations can be applied programmatically and on-demand across entire image libraries, removing the need to batch process or maintain multiple copies of an image to match device breakpoints.

This section of the documentation describes all of the parameters available in the imgix URL API and links to live examples that you can experiment with in our Sandbox. For more detailed information about how to implement for specific use cases, please see the Tutorials section. To learn more about the basics of serving images once you’ve set up the service, read the Serving Images guide.

Supported Image Formats

imgix supports the following image formats as input. For output format options, please see the fm parameter.

  • JPEG, JPEG2000
  • PNG
  • GIF, Animated GIF
  • TIFF
  • BMP
  • ICNS
  • ICO
  • PDF
  • PCT
  • PSD
  • AI

Base64 Variants

All parameters documented on imgix also have the ability to be encoded using a URL-safe Base64 scheme. To use a this approach, simply append 64 to the end of a parameter name. For example, txt becomes txt64.

Please keep in mind that this uses the URL-safe alphabet as defined in RFC 4648.

Here’s an example:

?txt=Hello%2C%20World!

becomes the following when URL-safe Base64 encoded:

?txt64=SGVsbG8sIFdvcmxkIQ

Generating Base64-encoded parameters is easy in many languages. Here’s an example of how to do it in Ruby:

require "base64"
Base64.urlsafe_encode64("Hello, World!").delete('=')
#=> "SGVsbG8sIFdvcmxkIQ"

Many of the imgix client libraries automatically encode strings passed to Base64 variant parameters. Check whichever library you’re using for specific details of its implementation.

Adjustment

Automatic

Background Color

Blending

Border & Padding

Color Palette

Device Pixel Ratio

Face Detection

Focal Point Crop

Format

Mask Image

Noise Reduction

PDF Page Number

Rotation

Size

Stylize

Text

Trim

Typesetting Endpoint

Watermark