Rendering API

  1. Documentation
  2. imgix APIs
  3. Rendering API

Rendering API Reference

The imgix Rendering API can optimize your images, improve your page speed, and make it easy to create responsive designs.

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 in real time 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 Rendering API and includes live examples that you can experiment with. 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.

Base64 Variants

All imgix parameter values (with the exception of auto and ch) can be encoded using a URL-safe Base64 scheme. To use this approach, pre-encode the value, and append 64 to the end of the parameter name. For example, txt becomes txt64.

Please keep in mind that this uses the URL-safe alphabet as defined in RFC 4648, and that any padding characters (=) must be omitted from the final encoded value.

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.

Colors

Some parameters, such as bg and border, accept colors as values. Colors can be expressed as either:

  • A color keyword, such as "orange" or "lightsteelblue". See the full list of accepted color keywords.
  • 3- (RGB), 4- (ARGB) 6- (RRGGBB) or 8-digit (AARRGGBB) hexadecimal values. The "A" in a 4- or 8-digit hex value represents the color's alpha transparency. When outputting image formats that do not support transparency (such as JPEG), set this value to a non-transparent color.

Metadata

By default, imgix will strip most metadata (EXIF data, geolocation, etc.) from any image processed by imgix. The only exception is for images that are served via passthrough.

If you need to have Copyright or IPTC metadata preserved on your images, please contact us.

Limits

  • Canvas size: The maximum supported canvas size is 8192px by 8192px. If your image is larger than the limit, it will be resized to fit within the limit before any other imgix operations occur. If you require a larger canvas size, please contact us.
  • Input file size: The maximum accepted input file size is 500MB. If your image is larger than the limit, you may receive a 413 Entity Too Large error. If you require a larger input file size, please contact us.

All Parameters (by Category)

Adjustment

Animation

Automatic

Background Removal

Blending

Border & Padding

Color Palette

Expiration

Face Detection

Fill

Focal Point Crop

Format

Mask Image

Noise Reduction

PDF

Pixel Density

Rotation

Size

Stylize

Text

Trim

Typesetting Endpoint

Watermark