Image transformations

Whether your web application supports user uploaded images, you deliver static images, or you display profile pictures from social networks, you probably need to manipulate them to fit the graphic design of your Web site or mobile application.

For example, the following dynamic URL with on-the-fly image transformation crops an image to a 400x400 circular thumbnail while automatically focusing on the face, and then scales down the result to a width of 200 pixels. Below you can see the original image (scaled down) and the dynamically created face detection based thumbnail.

Sample lady image

Sample image using the crop, face detection, rounded corners and resize features

Ruby:
cl_image_tag("lady.jpg", :transformation=>[
  {:width=>400, :height=>400, :gravity=>"face", :radius=>"max", :crop=>"crop"},
  {:width=>200, :crop=>"scale"}
  ])
PHP:
cl_image_tag("lady.jpg", array("transformation"=>array(
  array("width"=>400, "height"=>400, "gravity"=>"face", "radius"=>"max", "crop"=>"crop"),
  array("width"=>200, "crop"=>"scale")
  )))
Python:
CloudinaryImage("lady.jpg").image(transformation=[
  {"width": 400, "height": 400, "gravity": "face", "radius": "max", "crop": "crop"},
  {"width": 200, "crop": "scale"}
  ])
Node.js:
cloudinary.image("lady.jpg", {transformation: [
  {width: 400, height: 400, gravity: "face", radius: "max", crop: "crop"},
  {width: 200, crop: "scale"}
  ]})
Java:
cloudinary.url().transformation(new Transformation()
  .width(400).height(400).gravity("face").radius("max").crop("crop").chain()
  .width(200).crop("scale")).imageTag("lady.jpg")
JS:
cl.imageTag('lady.jpg', {transformation: [
  {width: 400, height: 400, gravity: "face", radius: "max", crop: "crop"},
  {width: 200, crop: "scale"}
  ]}).toHtml();
jQuery:
$.cloudinary.image("lady.jpg", {transformation: [
  {width: 400, height: 400, gravity: "face", radius: "max", crop: "crop"},
  {width: 200, crop: "scale"}
  ]})
React:
<Image publicId="lady.jpg" >
        <Transformation width=400 height=400 gravity="face" radius="max" crop="crop" />
        <Transformation width=200 crop="scale" />
</Image>
Angular:
<cl-image public-id="lady.jpg" >
        <cl-transformation width=400 height=400 gravity="face" radius="max" crop="crop" />
        <cl-transformation width=200 crop="scale" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation()
  .Width(400).Height(400).Gravity("face").Radius("max").Crop("crop").Chain()
  .Width(200).Crop("scale")).BuildImageTag("lady.jpg")

Cloudinary allows you to easily transform your images on-the-fly to any required format, style and dimension, and also optimizes images to have the minimal file size for an improved user experience and for saving bandwidth. Doing so is done by implementing dynamic image transformation and delivery URLs for accessing the images. You can change the required transformations at any time and all transformed images will be created on-demand (lazily) and delivered to your users through a fast CDN with optimized caching.

You can specify the required height and width, define the way to crop the image, and select the image format that fits your needs. You can also use our face detection based cropping techniques for focusing on the most relevant part of user uploaded photos. For complex transformations, you can use the Management Console or Admin API for defining named transformations and even run a set of chained transformations on your images. You can also use the Management Console to view delivery usage reports and optimization insights.

Cloudinary's image management service supports the following image transformation and delivery capabilities:

The Image Transformations Reference table summarizes the extensive list of parameters available for manipulating images.

Cloudinary's client libraries (SDKs) take care of the transformation URL building for you, and simplify the integration even further. They allow you to continue working in your preferred developer framework and provide helper methods to simplify building image tags and image transformation URLs: Rails, PHP, Django, jQuery, Node.js, .NET, Java, Angular, Javascript, iOS, Scala and Android.

Delivering images using dynamic URLs

Accessing images is done using simple delivery HTTP or HTTPS URLs which are then delivered to users via a worldwide fast CDN. The URL contains the Public ID of the requested image plus any optional transformation parameters. Public ID is the unique identifier of the image and is either specified when uploading the image to your Cloudinary account, or automatically assigned by Cloudinary (see Upload images for more details on the various options for specifying the public ID).

The Cloudinary resource delivery URL takes the following structure:

http://res.cloudinary.com/<cloud_name>/<resource_type>/<type>/<version>/<public_id>.<format>

Where:

  • cloud_name - the name of your Cloudinary account, a unique public identifier for URL building and API access.
  • resource_type is the type of file to deliver. Valid values: image, raw, and video (note that there are other valid values when fetching remote images: see Fetching images from remote locations for more information).
  • type - the level of accessibility of the file to deliver. Valid values: upload, private and authenticated.
  • version - (optional) can be added to the delivery URL in order to bypass the cached version on the CDN and force delivery of the latest resource (in the case that a resource has been overwritten with a newer file). The version component is generally not included in the example URLs on this page in order to keep them simple. See Image versions for more information.
  • public_id - the unique identifier of the resource, including the folder structure if defined.
  • format - (optional) the file extension of the requested delivery format for the resource. The resource is delivered in the original uploaded format if the file extension is not included.

Therefore, in the most general case of delivering an image that has been uploaded to your Cloudinary account, the delivery URL is given as:

http://res.cloudinary.com/<cloud_name>/image/upload/<public_id>.<format>

For example, displaying the image with a public ID of sample uploaded to Cloudinary's demo account in jpg format:

Ruby:
cl_image_tag("sample.jpg")
PHP:
cl_image_tag("sample.jpg")
Python:
CloudinaryImage("sample.jpg").image()
Node.js:
cloudinary.image("sample.jpg")
Java:
cloudinary.url().imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg').toHtml();
jQuery:
$.cloudinary.image("sample.jpg")
React:
<Image publicId="sample.jpg" >

</Image>
Angular:
<cl-image public-id="sample.jpg" >

</cl-image>
.Net:
cloudinary.Api.UrlImgUp.BuildImageTag("sample.jpg")
Sample image

Any transformation (manipulation) instructions can be added before the public ID in the delivery URL. When the URL is first accessed, the derived image is created on-the-fly and delivered to your user. The derived image is also cached on the CDN and is immediately available to all subsequent users requesting the same image. The image delivery URL with transformation parameters takes the following structure:

http://res.cloudinary.com/<cloud name>/image/upload/<transformation parameters>/<public ID>.<image format file extension>

Following is an example of delivering an image with transformation parameters, where the image with a public ID of sample is cropped to a width of 300 pixels and a height of 200 pixels, and delivered in JPEG format:

Ruby:
cl_image_tag("sample.jpg", :width=>300, :height=>200, :crop=>"crop")
PHP:
cl_image_tag("sample.jpg", array("width"=>300, "height"=>200, "crop"=>"crop"))
Python:
CloudinaryImage("sample.jpg").image(width=300, height=200, crop="crop")
Node.js:
cloudinary.image("sample.jpg", {width: 300, height: 200, crop: "crop"})
Java:
cloudinary.url().transformation(new Transformation().width(300).height(200).crop("crop")).imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg', {width: 300, height: 200, crop: "crop"}).toHtml();
jQuery:
$.cloudinary.image("sample.jpg", {width: 300, height: 200, crop: "crop"})
React:
<Image publicId="sample.jpg" width="300" height="200" crop="crop">
        <Transformation width=300 height=200 crop="crop" />
</Image>
Angular:
<cl-image public-id="sample.jpg" width="300" height="200" crop="crop">
        <cl-transformation width=300 height=200 crop="crop" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(300).Height(200).Crop("crop")).BuildImageTag("sample.jpg")
Image cropped to 300x200

You can also use shortcut URLs for specifically delivering uploaded images. With Cloudinary’s Root Path URL feature, the resource type and type parameters can be omitted from the URL (they automatically default to the values 'image' and 'upload' respectively). For example, the Root Path shortcut delivery URL for the cropped image above is:

http://res.cloudinary.com/demo/w_300,h_200,c_crop/sample.jpg

The rest of this page documents the various transformation and delivery options, and you can also see the Image Transformations Reference table for an overview on the extensive list of possible parameters and their values.

Secure HTTPS URLs

Cloudinary supports delivering images using HTTPS URLs. The process for creating HTTPS delivery URLs is identical to creating HTTP URLs, with only the URL protocol changing. When using one of Cloudinary's framework SDKs, you can generate HTTPS URLs by setting the secure parameter to true, either globally (e.g., in the CLOUDINARY_URL environment variable) or locally in each call. For example, delivering the sample image with HTTPS:

Ruby:
cl_image_tag("sample.jpg", :secure=>true)
PHP:
cl_image_tag("sample.jpg", array("secure"=>true))
Python:
CloudinaryImage("sample.jpg").image(secure=True)
Node.js:
cloudinary.image("sample.jpg", {secure: true})
Java:
cloudinary.url().secure(true).imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg', {secure: true}).toHtml();
jQuery:
$.cloudinary.image("sample.jpg", {secure: true})
React:
<Image publicId="sample.jpg" secure="true">

</Image>
Angular:
<cl-image public-id="sample.jpg" secure="true">

</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Secure(true).BuildImageTag("sample.jpg")
HTTPS delivered image

For more information on using HTTPS to deliver your images, see the article on Why isn't everyone using HTTPS and how to do it with Cloudinary.

Embedding images in web pages

Accessing uploaded images or their derived transformations is done using simple URLs that you can use as the 'src' of the 'img' tags in your HTML code or Javascript functions. URLs for accessing resources contain the resource kind, the Public ID of the resource, and optional version and transformation parameters. You can also use Cloudinary’s web framework SDKs to aid you in adding images to your web application and simplify the creation of transformation URLs and embedding HTML image tags. Cloudinary offers two main helper methods in this regard:

The Cloudinary URL helper method (e.g., cloudinary_url in Ruby on Rails) automatically generates the image source URL for use as the 'src' of the 'img' tags in your HTML code or Javascript functions. For example, using the URL helper method to return the URL of the sample image, scaled to a width of 300 pixels and a height of 100 pixels:

Ruby:
cloudinary_url("sample.jpg", :width=>300, :height=>100, :crop=>"scale", :secure=>true)
PHP:
Cloudinary::cloudinary_url("sample.jpg", array("width"=>300, "height"=>100, "crop"=>"scale", "secure"=>true))
Python:
cloudinary.utils.cloudinary_url("sample.jpg", width=300, height=100, crop="scale", secure=True)
Node.js:
cloudinary.url("sample.jpg", {width: 300, height: 100, crop: "scale", secure: true})
Java:
cloudinary.url().transformation(new Transformation().width(300).height(100).crop("scale")).secure(true).generate("sample.jpg")
JS:
cl.url('sample.jpg', {width: 300, height: 100, crop: "scale", secure: true});
jQuery:
$.cloudinary.url("sample.jpg", {width: 300, height: 100, crop: "scale", secure: true})
React:
<Image publicId="sample.jpg" width="300" height="100" crop="scale" secure="true">
        <Transformation width=300 height=100 crop="scale" />
</Image>
Angular:
<cl-image public-id="sample.jpg" width="300" height="100" crop="scale" secure="true">
        <cl-transformation width=300 height=100 crop="scale" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(300).Height(100).Crop("scale")).Secure(true).BuildUrl("sample.jpg")

The Cloudinary Image Tag helper method (e.g., cl_image_tag in Ruby on Rails) automatically generates an HTML image tag including the image source URL. For example, using the Image Tag helper method to create an HTML image tag for the sample image, scaled to a width of 300 pixels and a height of 100 pixels:

Ruby:
cl_image_tag("sample.jpg", :width=>300, :height=>100, :crop=>"scale", :secure=>true)
PHP:
cl_image_tag("sample.jpg", array("width"=>300, "height"=>100, "crop"=>"scale", "secure"=>true))
Python:
CloudinaryImage("sample.jpg").image(width=300, height=100, crop="scale", secure=True)
Node.js:
cloudinary.image("sample.jpg", {width: 300, height: 100, crop: "scale", secure: true})
Java:
cloudinary.url().transformation(new Transformation().width(300).height(100).crop("scale")).secure(true).imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg', {width: 300, height: 100, crop: "scale", secure: true}).toHtml();
jQuery:
$.cloudinary.image("sample.jpg", {width: 300, height: 100, crop: "scale", secure: true})
React:
<Image publicId="sample.jpg" width="300" height="100" crop="scale" secure="true">
        <Transformation width=300 height=100 crop="scale" />
</Image>
Angular:
<cl-image public-id="sample.jpg" width="300" height="100" crop="scale" secure="true">
        <cl-transformation width=300 height=100 crop="scale" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(300).Height(100).Crop("scale")).Secure(true).BuildImageTag("sample.jpg")

The Cloudinary Image Tag helper method allows you to not only specify any Cloudinary transformations parameters, but also to specify regular HTML image tag attributes (e.g., alt, title, width, height).

Notes:

  • Specifying the width and height parameters without a crop mode will add them only as parameters of the HTML <img> tag.
    Specifying the width and height parameters with a crop mode will add them as transformation parameters in the image source URL. Additionally:

    • For 'fixed' crop modes like crop, scale and fill, where the width and height parameters determine the exact final size, the specified width and height transformation parameters are additionally added as parameters of the HTML <img> tag. This way, if an image takes a few moments to load, the required space will already be reserved, preventing surrounding content from jumping when the image loads.
    • For 'variable' crop modes like fit, limit, lfill, etc., where the specified width and height may only be a minimum or maximum value, the width and height are only added to the transformation URL and not as parameters of the HTML <img> tag.
  • Using a full URL (e.g., http://res.cloudinary.com/demo/image/upload/sample.jpg) instead of only the public ID (e.g., sample.jpg) in the first parameter of the helper methods will result in all other parameters of the helper method being ignored and only using the full URL as the final generated URL.

For more information on these helper methods, see the documentation for the relevant framework: Ruby on Rails, PHP, Django, Node.js, Java, .NET, Angular, Javascript, iOS, Scala and Android.

Resizing and cropping images

You can resize and crop images in order to match the graphic design of your web site or mobile application. Whether images are uploaded in your server-side code or by your users, the original hi-res images are stored in the cloud for further processing and management. You can then dynamically create multiple resized, cropped and manipulated images on-the-fly and deliver them via dynamic URLs.

To change the size of a image, use the width and height parameters (w and h in URLs) to assign new values. You can resize the image by using both the width and height parameters or with only one of them: the other dimension is automatically updated to maintain the aspect ratio.

  • Using an integer value sets the new dimension to that number in pixels. For example, w_150 sets the width to exactly 150 pixels.
  • Using a decimal value sets the new dimension as a multiple of the original dimension. For example, w_0.5 sets the width to half the original width.
  • Using ih or iw as values sets the dimension to the initial height or initial width of the original image respectively. For example, w_iw sets the width to the same value as the original width of the image. This may be useful when applying chained transformations or setting the dimensions of an overlay.

Examples of resizing the uploaded jpg image named sample:

  1. Resizing the width to half the original width, maintaining the aspect ratio:

    Ruby:
    cl_image_tag("sample.jpg", :width=>0.5, :crop=>"scale")
    PHP:
    cl_image_tag("sample.jpg", array("width"=>0.5, "crop"=>"scale"))
    Python:
    CloudinaryImage("sample.jpg").image(width=0.5, crop="scale")
    Node.js:
    cloudinary.image("sample.jpg", {width: 0.5, crop: "scale"})
    Java:
    cloudinary.url().transformation(new Transformation().width(0.5).crop("scale")).imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg', {width: 0.5, crop: "scale"}).toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg", {width: 0.5, crop: "scale"})
    React:
    <Image publicId="sample.jpg" width="0.5" crop="scale">
            <Transformation width=0.5 crop="scale" />
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" width="0.5" crop="scale">
            <cl-transformation width=0.5 crop="scale" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(0.5).Crop("scale")).BuildImageTag("sample.jpg")
    Image scaled to half width

  2. Resizing the height to 200 pixels, maintaining the aspect ratio:

    Ruby:
    cl_image_tag("sample.jpg", :height=>200, :crop=>"scale")
    PHP:
    cl_image_tag("sample.jpg", array("height"=>200, "crop"=>"scale"))
    Python:
    CloudinaryImage("sample.jpg").image(height=200, crop="scale")
    Node.js:
    cloudinary.image("sample.jpg", {height: 200, crop: "scale"})
    Java:
    cloudinary.url().transformation(new Transformation().height(200).crop("scale")).imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg', {height: 200, crop: "scale"}).toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg", {height: 200, crop: "scale"})
    React:
    <Image publicId="sample.jpg" height="200" crop="scale">
            <Transformation height=200 crop="scale" />
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" height="200" crop="scale">
            <cl-transformation height=200 crop="scale" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Height(200).Crop("scale")).BuildImageTag("sample.jpg")
    Image scaled to a height of 200 pixels

  3. Resizing to a width of 200 pixels and a height of 100 pixels:

    Ruby:
    cl_image_tag("sample.jpg", :width=>200, :height=>100, :crop=>"scale")
    PHP:
    cl_image_tag("sample.jpg", array("width"=>200, "height"=>100, "crop"=>"scale"))
    Python:
    CloudinaryImage("sample.jpg").image(width=200, height=100, crop="scale")
    Node.js:
    cloudinary.image("sample.jpg", {width: 200, height: 100, crop: "scale"})
    Java:
    cloudinary.url().transformation(new Transformation().width(200).height(100).crop("scale")).imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg', {width: 200, height: 100, crop: "scale"}).toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg", {width: 200, height: 100, crop: "scale"})
    React:
    <Image publicId="sample.jpg" width="200" height="100" crop="scale">
            <Transformation width=200 height=100 crop="scale" />
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" width="200" height="100" crop="scale">
            <cl-transformation width=200 height=100 crop="scale" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(200).Height(100).Crop("scale")).BuildImageTag("sample.jpg")
    Image scaled to 200x100

When changing the dimensions of an uploaded image by manipulating the image's height and/or width, you need to decide how to adapt or "crop" the image to fit into the requested size. Use the crop parameter for selecting the crop mode (c in URLs). Cloudinary supports the following image cropping modes: scale, fit, mfit, fill, lfill, limit, pad, lpad, mpad, crop, thumb, imagga_crop and imagga_scale.

Note: When creating dynamic delivery URLs, the image is scaled to the new dimensions by default (as in the examples above), unless a different cropping mode is selected. However, there is no default value when using the Cloudinary SDK helper methods (see Embedding images in web pages), and a cropping mode must be explicitly selected.

scale

Change the size of the image exactly to the given width and height without necessarily retaining the original aspect ratio: all original image parts are visible but might be stretched or shrunk. If only the width or height is given, then the image is scaled to the new dimension while retaining the original aspect ratio, unless you also include the ignore_aspect_ratio flag). This is the default cropping mode for resizing images if the crop mode is not specified.

Examples of scaling the uploaded image named sample:

  1. Scaled to a width of 150 pixels (maintains the aspect ratio by default):

    Ruby:
    cl_image_tag("sample.jpg", :width=>150, :crop=>"scale")
    PHP:
    cl_image_tag("sample.jpg", array("width"=>150, "crop"=>"scale"))
    Python:
    CloudinaryImage("sample.jpg").image(width=150, crop="scale")
    Node.js:
    cloudinary.image("sample.jpg", {width: 150, crop: "scale"})
    Java:
    cloudinary.url().transformation(new Transformation().width(150).crop("scale")).imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg', {width: 150, crop: "scale"}).toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg", {width: 150, crop: "scale"})
    React:
    <Image publicId="sample.jpg" width="150" crop="scale">
            <Transformation width=150 crop="scale" />
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" width="150" crop="scale">
            <cl-transformation width=150 crop="scale" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(150).Crop("scale")).BuildImageTag("sample.jpg")
    Image scaled to a width of 150 pixels

  2. Scaled to a width and height of 150 pixels without maintaining the aspect ratio:

    Ruby:
    cl_image_tag("sample.jpg", :width=>150, :height=>150, :crop=>"scale")
    PHP:
    cl_image_tag("sample.jpg", array("width"=>150, "height"=>150, "crop"=>"scale"))
    Python:
    CloudinaryImage("sample.jpg").image(width=150, height=150, crop="scale")
    Node.js:
    cloudinary.image("sample.jpg", {width: 150, height: 150, crop: "scale"})
    Java:
    cloudinary.url().transformation(new Transformation().width(150).height(150).crop("scale")).imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg', {width: 150, height: 150, crop: "scale"}).toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg", {width: 150, height: 150, crop: "scale"})
    React:
    <Image publicId="sample.jpg" width="150" height="150" crop="scale">
            <Transformation width=150 height=150 crop="scale" />
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" width="150" height="150" crop="scale">
            <cl-transformation width=150 height=150 crop="scale" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(150).Height(150).Crop("scale")).BuildImageTag("sample.jpg")
    Image scaled to a width and height of 150 pixels

  3. Scaled to a width of 25% (maintains the aspect ratio by default):

    Ruby:
    cl_image_tag("sample.jpg", :width=>0.25, :crop=>"scale")
    PHP:
    cl_image_tag("sample.jpg", array("width"=>0.25, "crop"=>"scale"))
    Python:
    CloudinaryImage("sample.jpg").image(width=0.25, crop="scale")
    Node.js:
    cloudinary.image("sample.jpg", {width: 0.25, crop: "scale"})
    Java:
    cloudinary.url().transformation(new Transformation().width(0.25).crop("scale")).imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg', {width: 0.25, crop: "scale"}).toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg", {width: 0.25, crop: "scale"})
    React:
    <Image publicId="sample.jpg" width="0.25" crop="scale">
            <Transformation width=0.25 crop="scale" />
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" width="0.25" crop="scale">
            <cl-transformation width=0.25 crop="scale" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(0.25).Crop("scale")).BuildImageTag("sample.jpg")
    Image scaled to a width of 25%

fit

The image is resized so that it takes up as much space as possible within a bounding box defined by the given width and height parameters. The original aspect ratio is retained and all of the original image is visible.

For example, the uploaded image named sample is resized to fit within a width and height of 250 pixels while retaining the aspect ratio:

Ruby:
cl_image_tag("sample.jpg", :width=>250, :height=>250, :crop=>"fit")
PHP:
cl_image_tag("sample.jpg", array("width"=>250, "height"=>250, "crop"=>"fit"))
Python:
CloudinaryImage("sample.jpg").image(width=250, height=250, crop="fit")
Node.js:
cloudinary.image("sample.jpg", {width: 250, height: 250, crop: "fit"})
Java:
cloudinary.url().transformation(new Transformation().width(250).height(250).crop("fit")).imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg', {width: 250, height: 250, crop: "fit"}).toHtml();
jQuery:
$.cloudinary.image("sample.jpg", {width: 250, height: 250, crop: "fit"})
React:
<Image publicId="sample.jpg" width="250" height="250" crop="fit">
        <Transformation width=250 height=250 crop="fit" />
</Image>
Angular:
<cl-image public-id="sample.jpg" width="250" height="250" crop="fit">
        <cl-transformation width=250 height=250 crop="fit" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(250).Height(250).Crop("fit")).BuildImageTag("sample.jpg")
Image fit to a width and height of 250 pixels

limit

Same as the fit mode but only if the original image is larger than the given limit (width and height), in which case the image is scaled down so that it takes up as much space as possible within a bounding box defined by the given width and height parameters. The original aspect ratio is retained and all of the original image is visible. This mode doesn't scale up the image if your requested dimensions are larger than the original image's.

For example, the uploaded jpg image named sample limited to a width and height of 250 pixels while retaining the aspect ratio:

Ruby:
cl_image_tag("sample.jpg", :width=>250, :height=>250, :crop=>"limit")
PHP:
cl_image_tag("sample.jpg", array("width"=>250, "height"=>250, "crop"=>"limit"))
Python:
CloudinaryImage("sample.jpg").image(width=250, height=250, crop="limit")
Node.js:
cloudinary.image("sample.jpg", {width: 250, height: 250, crop: "limit"})
Java:
cloudinary.url().transformation(new Transformation().width(250).height(250).crop("limit")).imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg', {width: 250, height: 250, crop: "limit"}).toHtml();
jQuery:
$.cloudinary.image("sample.jpg", {width: 250, height: 250, crop: "limit"})
React:
<Image publicId="sample.jpg" width="250" height="250" crop="limit">
        <Transformation width=250 height=250 crop="limit" />
</Image>
Angular:
<cl-image public-id="sample.jpg" width="250" height="250" crop="limit">
        <cl-transformation width=250 height=250 crop="limit" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(250).Height(250).Crop("limit")).BuildImageTag("sample.jpg")
Image limited to a width and height of 250 pixels

mfit (minimum fit)

Same as the fit mode but only if the original image is smaller than the given minimum (width and height), in which case the image is scaled up so that it takes up as much space as possible within a bounding box defined by the given width and height parameters. The original aspect ratio is retained and all of the original image is visible. This mode doesn't scale down the image if your requested dimensions are smaller than the original image's.

For example, attempting to fit the uploaded image named sample to a minimum width and height of 250 pixels while retaining the aspect ratio, results in delivering the original larger image:

Ruby:
cl_image_tag("sample.jpg", :width=>250, :height=>250, :crop=>"mfit")
PHP:
cl_image_tag("sample.jpg", array("width"=>250, "height"=>250, "crop"=>"mfit"))
Python:
CloudinaryImage("sample.jpg").image(width=250, height=250, crop="mfit")
Node.js:
cloudinary.image("sample.jpg", {width: 250, height: 250, crop: "mfit"})
Java:
cloudinary.url().transformation(new Transformation().width(250).height(250).crop("mfit")).imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg', {width: 250, height: 250, crop: "mfit"}).toHtml();
jQuery:
$.cloudinary.image("sample.jpg", {width: 250, height: 250, crop: "mfit"})
React:
<Image publicId="sample.jpg" width="250" height="250" crop="mfit">
        <Transformation width=250 height=250 crop="mfit" />
</Image>
Angular:
<cl-image public-id="sample.jpg" width="250" height="250" crop="mfit">
        <cl-transformation width=250 height=250 crop="mfit" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(250).Height(250).Crop("mfit")).BuildImageTag("sample.jpg")
Image mfit to a width and height of 250 pixels

fill

Create an image with the exact given width and height while retaining the original aspect ratio, using only part of the image that fills the given dimensions if necessary (only part of the original image might be visible if the requested aspect ratio is different from the original aspect ratio). You can also specify which part of the original image to use for filling the required dimensions in case the proportions do not match by using the gravity parameter (set to center by default).

Examples of fill used with the uploaded jpg image named sample:

  1. Filled to a width and height of 250 pixels while retaining the aspect ratio:

    Ruby:
    cl_image_tag("sample.jpg", :width=>250, :height=>250, :crop=>"fill")
    PHP:
    cl_image_tag("sample.jpg", array("width"=>250, "height"=>250, "crop"=>"fill"))
    Python:
    CloudinaryImage("sample.jpg").image(width=250, height=250, crop="fill")
    Node.js:
    cloudinary.image("sample.jpg", {width: 250, height: 250, crop: "fill"})
    Java:
    cloudinary.url().transformation(new Transformation().width(250).height(250).crop("fill")).imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg', {width: 250, height: 250, crop: "fill"}).toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg", {width: 250, height: 250, crop: "fill"})
    React:
    <Image publicId="sample.jpg" width="250" height="250" crop="fill">
            <Transformation width=250 height=250 crop="fill" />
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" width="250" height="250" crop="fill">
            <cl-transformation width=250 height=250 crop="fill" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(250).Height(250).Crop("fill")).BuildImageTag("sample.jpg")
    Image filled to a width and height of 250 pixels

  2. Filled to a width and height of 250 pixels with east gravity:

    Ruby:
    cl_image_tag("sample.jpg", :width=>250, :height=>250, :gravity=>"east", :crop=>"fill")
    PHP:
    cl_image_tag("sample.jpg", array("width"=>250, "height"=>250, "gravity"=>"east", "crop"=>"fill"))
    Python:
    CloudinaryImage("sample.jpg").image(width=250, height=250, gravity="east", crop="fill")
    Node.js:
    cloudinary.image("sample.jpg", {width: 250, height: 250, gravity: "east", crop: "fill"})
    Java:
    cloudinary.url().transformation(new Transformation().width(250).height(250).gravity("east").crop("fill")).imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg', {width: 250, height: 250, gravity: "east", crop: "fill"}).toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg", {width: 250, height: 250, gravity: "east", crop: "fill"})
    React:
    <Image publicId="sample.jpg" width="250" height="250" gravity="east" crop="fill">
            <Transformation width=250 height=250 gravity="east" crop="fill" />
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" width="250" height="250" gravity="east" crop="fill">
            <cl-transformation width=250 height=250 gravity="east" crop="fill" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(250).Height(250).Gravity("east").Crop("fill")).BuildImageTag("sample.jpg")
    Image filled to a width and height of 250 pixels with east gravity

lfill (limit fill)

Same as the fill mode but only if the original image is larger than the given limit (width and height), in which case the image is scaled down to fill the given width and height while retaining the original aspect ratio, using only part of the image that fills the given dimensions if necessary (only part of the original image might be visible if the requested aspect ratio is different from the original aspect ratio). You can also specify which part of the original image to use for filling the required dimensions in case the proportions do not match by using the gravity parameter. This mode doesn't scale up the image if your requested dimensions are bigger than the original image's.

For example, the uploaded image named sample limit filled to a width of 150 pixels and a height of 200 pixels while retaining the aspect ratio and limiting the size to no larger than the original image:

Ruby:
cl_image_tag("sample.jpg", :width=>150, :height=>200, :crop=>"lfill")
PHP:
cl_image_tag("sample.jpg", array("width"=>150, "height"=>200, "crop"=>"lfill"))
Python:
CloudinaryImage("sample.jpg").image(width=150, height=200, crop="lfill")
Node.js:
cloudinary.image("sample.jpg", {width: 150, height: 200, crop: "lfill"})
Java:
cloudinary.url().transformation(new Transformation().width(150).height(200).crop("lfill")).imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg', {width: 150, height: 200, crop: "lfill"}).toHtml();
jQuery:
$.cloudinary.image("sample.jpg", {width: 150, height: 200, crop: "lfill"})
React:
<Image publicId="sample.jpg" width="150" height="200" crop="lfill">
        <Transformation width=150 height=200 crop="lfill" />
</Image>
Angular:
<cl-image public-id="sample.jpg" width="150" height="200" crop="lfill">
        <cl-transformation width=150 height=200 crop="lfill" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(150).Height(200).Crop("lfill")).BuildImageTag("sample.jpg")
Image lfilled to a width of 150 and a height of 200 pixels

pad

Resize the image to fill the given width and height while retaining the original aspect ratio and with all of the original image visible. If the proportions of the original image do not match the given width and height, padding is added to the image to reach the required size. You can also specify where the original image is placed by using the gravity parameter (set to center by default), and specify the color of the background in the case that padding is added.

For example, the uploaded jpg image named sample padded with a black background to a width and height of 250 pixels:

Ruby:
cl_image_tag("sample.jpg", :width=>250, :height=>250, :background=>"black", :crop=>"pad")
PHP:
cl_image_tag("sample.jpg", array("width"=>250, "height"=>250, "background"=>"black", "crop"=>"pad"))
Python:
CloudinaryImage("sample.jpg").image(width=250, height=250, background="black", crop="pad")
Node.js:
cloudinary.image("sample.jpg", {width: 250, height: 250, background: "black", crop: "pad"})
Java:
cloudinary.url().transformation(new Transformation().width(250).height(250).background("black").crop("pad")).imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg', {width: 250, height: 250, background: "black", crop: "pad"}).toHtml();
jQuery:
$.cloudinary.image("sample.jpg", {width: 250, height: 250, background: "black", crop: "pad"})
React:
<Image publicId="sample.jpg" width="250" height="250" background="black" crop="pad">
        <Transformation width=250 height=250 background="black" crop="pad" />
</Image>
Angular:
<cl-image public-id="sample.jpg" width="250" height="250" background="black" crop="pad">
        <cl-transformation width=250 height=250 background="black" crop="pad" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(250).Height(250).Background("black").Crop("pad")).BuildImageTag("sample.jpg")
Image padded to a width and height of 250 pixels

lpad (limit pad)

Same as the pad mode but only if the original image is larger than the given limit (width and height), in which case the image is scaled down to fill the given width and height while retaining the original aspect ratio and with all of the original image visible. This mode doesn't scale up the image if your requested dimensions are bigger than the original image's. If the proportions of the original image do not match the given width and height, padding is added to the image to reach the required size. You can also specify where the original image is placed by using the gravity parameter (set to center by default), and specify the color of the background in the case that padding is added.

For example, the uploaded jpg image named sample limit padded with a green background to a width of 400 pixels and a height of 150 pixels:

Ruby:
cl_image_tag("sample.jpg", :width=>400, :height=>150, :background=>"green", :crop=>"lpad")
PHP:
cl_image_tag("sample.jpg", array("width"=>400, "height"=>150, "background"=>"green", "crop"=>"lpad"))
Python:
CloudinaryImage("sample.jpg").image(width=400, height=150, background="green", crop="lpad")
Node.js:
cloudinary.image("sample.jpg", {width: 400, height: 150, background: "green", crop: "lpad"})
Java:
cloudinary.url().transformation(new Transformation().width(400).height(150).background("green").crop("lpad")).imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg', {width: 400, height: 150, background: "green", crop: "lpad"}).toHtml();
jQuery:
$.cloudinary.image("sample.jpg", {width: 400, height: 150, background: "green", crop: "lpad"})
React:
<Image publicId="sample.jpg" width="400" height="150" background="green" crop="lpad">
        <Transformation width=400 height=150 background="green" crop="lpad" />
</Image>
Angular:
<cl-image public-id="sample.jpg" width="400" height="150" background="green" crop="lpad">
        <cl-transformation width=400 height=150 background="green" crop="lpad" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(400).Height(150).Background("green").Crop("lpad")).BuildImageTag("sample.jpg")
Image lpadded to a width and height of 250 pixels

mpad (minimum pad)

Same as the pad mode but only if the original image is smaller than the given minimum (width and height), in which case the image is scaled up to fill the given width and height while retaining the original aspect ratio and with all of the original image visible. This mode doesn't scale down the image if your requested dimensions are smaller than the original image's. If the proportions of the original image do not match the given width and height, padding is added to the image to reach the required size. You can also specify where the original image is placed by using the gravity parameter (set to center by default), and specify the color of the background in the case that padding is added.

For example, attempting to minimum pad the uploaded image named sample to a width and height of 250 pixels while retaining the aspect ratio, results in delivering the original larger image:

Ruby:
cl_image_tag("sample.jpg", :width=>250, :height=>250, :crop=>"mpad")
PHP:
cl_image_tag("sample.jpg", array("width"=>250, "height"=>250, "crop"=>"mpad"))
Python:
CloudinaryImage("sample.jpg").image(width=250, height=250, crop="mpad")
Node.js:
cloudinary.image("sample.jpg", {width: 250, height: 250, crop: "mpad"})
Java:
cloudinary.url().transformation(new Transformation().width(250).height(250).crop("mpad")).imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg', {width: 250, height: 250, crop: "mpad"}).toHtml();
jQuery:
$.cloudinary.image("sample.jpg", {width: 250, height: 250, crop: "mpad"})
React:
<Image publicId="sample.jpg" width="250" height="250" crop="mpad">
        <Transformation width=250 height=250 crop="mpad" />
</Image>
Angular:
<cl-image public-id="sample.jpg" width="250" height="250" crop="mpad">
        <cl-transformation width=250 height=250 crop="mpad" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(250).Height(250).Crop("mpad")).BuildImageTag("sample.jpg")
Image mpadded to a width and height of 250 pixels

crop

Extract a region of the given width and height out of the original image. The original proportions are retained and so is the size of the graphics. You can specify the gravity parameter to select which part of the image to extract, or use fixed coordinates cropping.

For example, the uploaded jpg image named sample cropped to a width of 200 pixels, a height of 150 pixels, with northwest gravity:

Ruby:
cl_image_tag("sample.jpg", :width=>200, :height=>150, :gravity=>"north_west", :crop=>"crop")
PHP:
cl_image_tag("sample.jpg", array("width"=>200, "height"=>150, "gravity"=>"north_west", "crop"=>"crop"))
Python:
CloudinaryImage("sample.jpg").image(width=200, height=150, gravity="north_west", crop="crop")
Node.js:
cloudinary.image("sample.jpg", {width: 200, height: 150, gravity: "north_west", crop: "crop"})
Java:
cloudinary.url().transformation(new Transformation().width(200).height(150).gravity("north_west").crop("crop")).imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg', {width: 200, height: 150, gravity: "north_west", crop: "crop"}).toHtml();
jQuery:
$.cloudinary.image("sample.jpg", {width: 200, height: 150, gravity: "north_west", crop: "crop"})
React:
<Image publicId="sample.jpg" width="200" height="150" gravity="north_west" crop="crop">
        <Transformation width=200 height=150 gravity="north_west" crop="crop" />
</Image>
Angular:
<cl-image public-id="sample.jpg" width="200" height="150" gravity="north_west" crop="crop">
        <cl-transformation width=200 height=150 gravity="north_west" crop="crop" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(200).Height(150).Gravity("north_west").Crop("crop")).BuildImageTag("sample.jpg")
Image cropped to 100x150 with west gravity

Fixed coordinates cropping

You can specify a region of the original image to crop by giving the x and y coordinates of the top left corner of the region together with the width and height of the region. You can also use percentage based numbers instead of the exact coordinates for x, y, w and h (e.g., 0.5 for 50%) . Use this method when you know beforehand what the correct absolute cropping coordinates are, as in when your users manually select the region to crop out of the original image.

For example, the following image shows many white sheep and one brown sheep.

Ruby:
cl_image_tag("brown_sheep.jpg")
PHP:
cl_image_tag("brown_sheep.jpg")
Python:
CloudinaryImage("brown_sheep.jpg").image()
Node.js:
cloudinary.image("brown_sheep.jpg")
Java:
cloudinary.url().imageTag("brown_sheep.jpg")
JS:
cl.imageTag('brown_sheep.jpg').toHtml();
jQuery:
$.cloudinary.image("brown_sheep.jpg")
React:
<Image publicId="brown_sheep.jpg" >

</Image>
Angular:
<cl-image public-id="brown_sheep.jpg" >

</cl-image>
.Net:
cloudinary.Api.UrlImgUp.BuildImageTag("brown_sheep.jpg")
Original image of brown_sheep

To manipulate the picture so that only the brown sheep is visible, the image is cropped to a 300x200 region starting at the coordinate x = 355 and y = 410:

Ruby:
cl_image_tag("brown_sheep.jpg", :x=>355, :y=>410, :width=>300, :height=>200, :crop=>"crop")
PHP:
cl_image_tag("brown_sheep.jpg", array("x"=>355, "y"=>410, "width"=>300, "height"=>200, "crop"=>"crop"))
Python:
CloudinaryImage("brown_sheep.jpg").image(x=355, y=410, width=300, height=200, crop="crop")
Node.js:
cloudinary.image("brown_sheep.jpg", {x: 355, y: 410, width: 300, height: 200, crop: "crop"})
Java:
cloudinary.url().transformation(new Transformation().x(355).y(410).width(300).height(200).crop("crop")).imageTag("brown_sheep.jpg")
JS:
cl.imageTag('brown_sheep.jpg', {x: 355, y: 410, width: 300, height: 200, crop: "crop"}).toHtml();
jQuery:
$.cloudinary.image("brown_sheep.jpg", {x: 355, y: 410, width: 300, height: 200, crop: "crop"})
React:
<Image publicId="brown_sheep.jpg" x="355" y="410" width="300" height="200" crop="crop">
        <Transformation x=355 y=410 width=300 height=200 crop="crop" />
</Image>
Angular:
<cl-image public-id="brown_sheep.jpg" x="355" y="410" width="300" height="200" crop="crop">
        <cl-transformation x=355 y=410 width=300 height=200 crop="crop" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().X(355).Y(410).Width(300).Height(200).Crop("crop")).BuildImageTag("brown_sheep.jpg")
300x200 image generated with fixed-coordinates cropping

The image can be further manipulated with chained transformations. For example, the 300x200 cropped version above, also scaled down to 150x100:

Ruby:
cl_image_tag("brown_sheep.jpg", :transformation=>[
  {:x=>355, :y=>410, :width=>300, :height=>200, :crop=>"crop"},
  {:width=>150, :height=>100, :crop=>"scale"}
  ])
PHP:
cl_image_tag("brown_sheep.jpg", array("transformation"=>array(
  array("x"=>355, "y"=>410, "width"=>300, "height"=>200, "crop"=>"crop"),
  array("width"=>150, "height"=>100, "crop"=>"scale")
  )))
Python:
CloudinaryImage("brown_sheep.jpg").image(transformation=[
  {"x": 355, "y": 410, "width": 300, "height": 200, "crop": "crop"},
  {"width": 150, "height": 100, "crop": "scale"}
  ])
Node.js:
cloudinary.image("brown_sheep.jpg", {transformation: [
  {x: 355, y: 410, width: 300, height: 200, crop: "crop"},
  {width: 150, height: 100, crop: "scale"}
  ]})
Java:
cloudinary.url().transformation(new Transformation()
  .x(355).y(410).width(300).height(200).crop("crop").chain()
  .width(150).height(100).crop("scale")).imageTag("brown_sheep.jpg")
JS:
cl.imageTag('brown_sheep.jpg', {transformation: [
  {x: 355, y: 410, width: 300, height: 200, crop: "crop"},
  {width: 150, height: 100, crop: "scale"}
  ]}).toHtml();
jQuery:
$.cloudinary.image("brown_sheep.jpg", {transformation: [
  {x: 355, y: 410, width: 300, height: 200, crop: "crop"},
  {width: 150, height: 100, crop: "scale"}
  ]})
React:
<Image publicId="brown_sheep.jpg" >
        <Transformation x=355 y=410 width=300 height=200 crop="crop" />
        <Transformation width=150 height=100 crop="scale" />
</Image>
Angular:
<cl-image public-id="brown_sheep.jpg" >
        <cl-transformation x=355 y=410 width=300 height=200 crop="crop" />
        <cl-transformation width=150 height=100 crop="scale" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation()
  .X(355).Y(410).Width(300).Height(200).Crop("crop").Chain()
  .Width(150).Height(100).Crop("scale")).BuildImageTag("brown_sheep.jpg")
fixed-coordinates cropped image also scaled down

thumb

The thumb cropping mode is specifically used for creating image thumbnails from either face or custom coordinates, and must always be accompanied by the gravity parameter set to one of the face detection or custom values. This cropping mode generates a thumbnail of an image with the exact given width and height dimensions and with the original proportions retained, but the resulting image might be scaled to fit in the given dimensions. You can specify the zoom parameter to determine how much to scale the resulting image within the given width and height.

For example, creating a 150x150 thumbnail with face detection, of the uploaded image called woman. Below you can see the original image as well as the face detection based thumbnail:

Original photo for face detection

Ruby:
cl_image_tag("woman.jpg", :gravity=>"face", :width=>150, :height=>150, :crop=>"thumb")
PHP:
cl_image_tag("woman.jpg", array("gravity"=>"face", "width"=>150, "height"=>150, "crop"=>"thumb"))
Python:
CloudinaryImage("woman.jpg").image(gravity="face", width=150, height=150, crop="thumb")
Node.js:
cloudinary.image("woman.jpg", {gravity: "face", width: 150, height: 150, crop: "thumb"})
Java:
cloudinary.url().transformation(new Transformation().gravity("face").width(150).height(150).crop("thumb")).imageTag("woman.jpg")
JS:
cl.imageTag('woman.jpg', {gravity: "face", width: 150, height: 150, crop: "thumb"}).toHtml();
jQuery:
$.cloudinary.image("woman.jpg", {gravity: "face", width: 150, height: 150, crop: "thumb"})
React:
<Image publicId="woman.jpg" gravity="face" width="150" height="150" crop="thumb">
        <Transformation gravity="face" width=150 height=150 crop="thumb" />
</Image>
Angular:
<cl-image public-id="woman.jpg" gravity="face" width="150" height="150" crop="thumb">
        <cl-transformation gravity="face" width=150 height=150 crop="thumb" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Gravity("face").Width(150).Height(150).Crop("thumb")).BuildImageTag("woman.jpg")
150x150 thumbnail with face detection

Imagga crop and scale

The Imagga Crop and Scale add-on can be used to smartly scale and crop your images based on automatically calculated areas of interest within each specific photo. See the Imagga Crop and Scale add-on documentation for more information.

For example, the original image:

Ruby:
cl_image_tag("family_bench.jpg")
PHP:
cl_image_tag("family_bench.jpg")
Python:
CloudinaryImage("family_bench.jpg").image()
Node.js:
cloudinary.image("family_bench.jpg")
Java:
cloudinary.url().imageTag("family_bench.jpg")
JS:
cl.imageTag('family_bench.jpg').toHtml();
jQuery:
$.cloudinary.image("family_bench.jpg")
React:
<Image publicId="family_bench.jpg" >

</Image>
Angular:
<cl-image public-id="family_bench.jpg" >

</cl-image>
.Net:
cloudinary.Api.UrlImgUp.BuildImageTag("family_bench.jpg")
Original image

Image with Imagga cropping:

Ruby:
cl_image_tag("family_bench.jpg", :crop=>"imagga_crop")
PHP:
cl_image_tag("family_bench.jpg", array("crop"=>"imagga_crop"))
Python:
CloudinaryImage("family_bench.jpg").image(crop="imagga_crop")
Node.js:
cloudinary.image("family_bench.jpg", {crop: "imagga_crop"})
Java:
cloudinary.url().transformation(new Transformation().crop("imagga_crop")).imageTag("family_bench.jpg")
JS:
cl.imageTag('family_bench.jpg', {crop: "imagga_crop"}).toHtml();
jQuery:
$.cloudinary.image("family_bench.jpg", {crop: "imagga_crop"})
React:
<Image publicId="family_bench.jpg" crop="imagga_crop">
        <Transformation crop="imagga_crop" />
</Image>
Angular:
<cl-image public-id="family_bench.jpg" crop="imagga_crop">
        <cl-transformation crop="imagga_crop" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Crop("imagga_crop")).BuildImageTag("family_bench.jpg")
Image with Imagga cropping

Aspect ratio based cropping

Use the aspect_ratio parameter (ar in URLs) to resize or crop the image to a new aspect ratio. This parameter is used together with a specified crop mode (scale, fill, lfill, pad, lpad, mpad or crop), that determines how the image is adjusted to the new dimensions. This parameter can also be used when changing the dimensions of an image with only the width or height parameters (w and h in URLs) - the other dimension is then automatically updated to maintain the given aspect ratio.

The aspect_ratio parameter accepts a value in one of the following forms:

  • a:b where a signifies the relative width and b the relative height (e.g., 4:3 or 16:9).
  • a decimal value representing the ratio of the width divided by the height (e.g., 1.33 or 2.5).

Examples with the uploaded image named sample:

  • Cropped to an aspect ratio of 2.5:
    Ruby:
    cl_image_tag("sample.jpg", :aspect_ratio=>"2.5", :crop=>"crop")
    PHP:
    cl_image_tag("sample.jpg", array("aspect_ratio"=>"2.5", "crop"=>"crop"))
    Python:
    CloudinaryImage("sample.jpg").image(aspect_ratio="2.5", crop="crop")
    Node.js:
    cloudinary.image("sample.jpg", {aspect_ratio: "2.5", crop: "crop"})
    Java:
    cloudinary.url().transformation(new Transformation().aspectRatio("2.5").crop("crop")).imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg', {aspect_ratio: "2.5", crop: "crop"}).toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg", {aspect_ratio: "2.5", crop: "crop"})
    React:
    <Image publicId="sample.jpg" aspect_ratio="2.5" crop="crop">
            <Transformation aspect_ratio="2.5" crop="crop" />
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" aspect_ratio="2.5" crop="crop">
            <cl-transformation aspect_ratio="2.5" crop="crop" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().AspectRatio("2.5").Crop("crop")).BuildImageTag("sample.jpg")
    Cropped to an aspect ratio of 2.5
  • Filled to an aspect ratio of 16:9:
    Ruby:
    cl_image_tag("sample.jpg", :aspect_ratio=>"16:9", :crop=>"fill")
    PHP:
    cl_image_tag("sample.jpg", array("aspect_ratio"=>"16:9", "crop"=>"fill"))
    Python:
    CloudinaryImage("sample.jpg").image(aspect_ratio="16:9", crop="fill")
    Node.js:
    cloudinary.image("sample.jpg", {aspect_ratio: "16:9", crop: "fill"})
    Java:
    cloudinary.url().transformation(new Transformation().aspectRatio("16:9").crop("fill")).imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg', {aspect_ratio: "16:9", crop: "fill"}).toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg", {aspect_ratio: "16:9", crop: "fill"})
    React:
    <Image publicId="sample.jpg" aspect_ratio="16:9" crop="fill">
            <Transformation aspect_ratio="16:9" crop="fill" />
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" aspect_ratio="16:9" crop="fill">
            <cl-transformation aspect_ratio="16:9" crop="fill" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().AspectRatio("16:9").Crop("fill")).BuildImageTag("sample.jpg")
    Filled to aspect ratio of 16:9
  • Filled to a width of 400 pixels with an aspect ratio of 4:3:
    Ruby:
    cl_image_tag("sample.jpg", :width=>400, :aspect_ratio=>"4:3", :crop=>"fill")
    PHP:
    cl_image_tag("sample.jpg", array("width"=>400, "aspect_ratio"=>"4:3", "crop"=>"fill"))
    Python:
    CloudinaryImage("sample.jpg").image(width=400, aspect_ratio="4:3", crop="fill")
    Node.js:
    cloudinary.image("sample.jpg", {width: 400, aspect_ratio: "4:3", crop: "fill"})
    Java:
    cloudinary.url().transformation(new Transformation().width(400).aspectRatio("4:3").crop("fill")).imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg', {width: 400, aspect_ratio: "4:3", crop: "fill"}).toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg", {width: 400, aspect_ratio: "4:3", crop: "fill"})
    React:
    <Image publicId="sample.jpg" width="400" aspect_ratio="4:3" crop="fill">
            <Transformation width=400 aspect_ratio="4:3" crop="fill" />
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" width="400" aspect_ratio="4:3" crop="fill">
            <cl-transformation width=400 aspect_ratio="4:3" crop="fill" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(400).AspectRatio("4:3").Crop("fill")).BuildImageTag("sample.jpg")
    Filled to a width of 400 pixels with an aspect ratio of 4:3

Set Device Pixel Ratio (DPR)

Different devices support different DPR values, which is defined as the ratio between physical pixels and logical pixels. This means that a device with support for a higher DPR uses more physical pixels for displaying an image, resulting in a clearer, sharper image.

DPR illustration

Use the dpr parameter to set the DPR value of the delivered image. The parameter accepts a numeric value specifying the DPR multiplier.

The dpr parameter is especially useful when adding overlays, as you need the overlay image to be correctly resized according to the required pixel density of the device (along with the containing image). Setting the dpr transformation parameter applies the same resizing rules both to the containing image, and the included overlay.

For example, the following URL dynamically generates a 100x100 face-detection-based circular thumbnail of an image named lady, and adds another image named cloudinary_icon as a semi-transparent watermark with a width of 50 pixels. Setting the dpr value to 1.0, 2.0 (as in the code example) or 3.0 generates the following images, while resizing both the containing image and the overlay to match the required DPR.

Ruby:
cl_image_tag("lady.jpg", :transformation=>[
  {:width=>100, :height=>100, :gravity=>"face", :radius=>"max", :crop=>"thumb"},
  {:overlay=>"cloudinary_icon", :effect=>"brightness:200", :flags=>"relative", :width=>0.5, :opacity=>60},
  {:dpr=>2.0}
  ])
PHP:
cl_image_tag("lady.jpg", array("transformation"=>array(
  array("width"=>100, "height"=>100, "gravity"=>"face", "radius"=>"max", "crop"=>"thumb"),
  array("overlay"=>"cloudinary_icon", "effect"=>"brightness:200", "flags"=>"relative", "width"=>0.5, "opacity"=>60),
  array("dpr"=>2.0)
  )))
Python:
CloudinaryImage("lady.jpg").image(transformation=[
  {"width": 100, "height": 100, "gravity": "face", "radius": "max", "crop": "thumb"},
  {"overlay": "cloudinary_icon", "effect": "brightness:200", "flags": "relative", "width": 0.5, "opacity": 60},
  {"dpr": 2.0}
  ])
Node.js:
cloudinary.image("lady.jpg", {transformation: [
  {width: 100, height: 100, gravity: "face", radius: "max", crop: "thumb"},
  {overlay: "cloudinary_icon", effect: "brightness:200", flags: "relative", width: 0.5, opacity: 60},
  {dpr: 2.0}
  ]})
Java:
cloudinary.url().transformation(new Transformation()
  .width(100).height(100).gravity("face").radius("max").crop("thumb").chain()
  .overlay("cloudinary_icon").effect("brightness:200").flags("relative").width(0.5).opacity(60).chain()
  .dpr(2.0)).imageTag("lady.jpg")
JS:
cl.imageTag('lady.jpg', {transformation: [
  {width: 100, height: 100, gravity: "face", radius: "max", crop: "thumb"},
  {overlay: "cloudinary_icon", effect: "brightness:200", flags: "relative", width: 0.5, opacity: 60},
  {dpr: 2.0}
  ]}).toHtml();
jQuery:
$.cloudinary.image("lady.jpg", {transformation: [
  {width: 100, height: 100, gravity: "face", radius: "max", crop: "thumb"},
  {overlay: "cloudinary_icon", effect: "brightness:200", flags: "relative", width: 0.5, opacity: 60},
  {dpr: 2.0}
  ]})
React:
<Image publicId="lady.jpg" >
        <Transformation width=100 height=100 gravity="face" radius="max" crop="thumb" />
        <Transformation overlay="cloudinary_icon" effect="brightness:200" flags="relative" width=0.5 opacity=60 />
        <Transformation dpr=2.0 />
</Image>
Angular:
<cl-image public-id="lady.jpg" >
        <cl-transformation width=100 height=100 gravity="face" radius="max" crop="thumb" />
        <cl-transformation overlay="cloudinary_icon" effect="brightness:200" flags="relative" width=0.5 opacity=60 />
        <cl-transformation dpr=2.0 />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation()
  .Width(100).Height(100).Gravity("face").Radius("max").Crop("thumb").Chain()
  .Overlay("cloudinary_icon").Effect("brightness:200").Flags("relative").Width(0.5).Opacity(60).Chain()
  .Dpr(2.0)).BuildImageTag("lady.jpg")

DPR 1.0 circular thumbnail with a watermark

DPR 2.0 circular thumbnail with a watermark

DPR 3.0 circular thumbnail with a watermark

    DPR 1.0                                        DPR 2.0                                                               DPR 3.0

Now you can create a 100x100 HTML image tag and deliver an image with the resolution that best matches the specified pixel density of your users' devices. The three images below are all displayed within a 100x100 logical square using the <img> tag width and height attributes, while you see more details and a better visual result for the last two images if you view this documentation using a device that supports a higher DPR.

<img
  src="http://res.cloudinary.com/demo/image/upload/c_thumb,w_100,h_100,g_face,r_max/l_cloudinary_icon,e_brightness:200,w_50,o_60/dpr_2.0/lady.jpg"
  height=100
  width=100 />

DPR 1.0 circular thumbnail with a watermark in HTML

DPR 2.0 circular thumbnail with a watermark  in HTML

DPR 3.0 circular thumbnail with a watermark in HTML

DPR 1.0 (100x100, 4.1KB)   DPR 2.0 (200x200, 10.1KB)         DPR 3.0 (300x300, 22.3KB)

You can alternatively use dpr_auto to automatically deliver the best image, depending on the requesting device's support for DPR. For details, see the Responsive images documentation.

Control gravity

The gravity parameter (g in URLs) is used to specify a location in the image that is used as the focus for another transformation:

  • For certain cropping modes, gravity specifies which part of the original image to focus on (include) when the resulting image is smaller than than the original or the proportions do not match.
  • For placing underlays, overlays or text captions, gravity specifies where to place them in relation to the original image.

The basic gravity value is specified by giving a compass direction to focus on: north_east, north, north_west, west, south_west, south, south_east, east, or center (the default value). The compass direction represents a location in the image, for example, north_east represents the top right corner.

For example, the uploaded jpg image named sample filled to a width and height of 250 pixels while retaining the aspect ratio:

  • Original image:
    Ruby:
    cl_image_tag("sample.jpg")
    PHP:
    cl_image_tag("sample.jpg")
    Python:
    CloudinaryImage("sample.jpg").image()
    Node.js:
    cloudinary.image("sample.jpg")
    Java:
    cloudinary.url().imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg').toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg")
    React:
    <Image publicId="sample.jpg" >
    
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" >
    
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.BuildImageTag("sample.jpg")
    Original image
  • With gravity set to north:
    Ruby:
    cl_image_tag("sample.jpg", :width=>250, :height=>250, :gravity=>"north", :crop=>"fill")
    PHP:
    cl_image_tag("sample.jpg", array("width"=>250, "height"=>250, "gravity"=>"north", "crop"=>"fill"))
    Python:
    CloudinaryImage("sample.jpg").image(width=250, height=250, gravity="north", crop="fill")
    Node.js:
    cloudinary.image("sample.jpg", {width: 250, height: 250, gravity: "north", crop: "fill"})
    Java:
    cloudinary.url().transformation(new Transformation().width(250).height(250).gravity("north").crop("fill")).imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg', {width: 250, height: 250, gravity: "north", crop: "fill"}).toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg", {width: 250, height: 250, gravity: "north", crop: "fill"})
    React:
    <Image publicId="sample.jpg" width="250" height="250" gravity="north" crop="fill">
            <Transformation width=250 height=250 gravity="north" crop="fill" />
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" width="250" height="250" gravity="north" crop="fill">
            <cl-transformation width=250 height=250 gravity="north" crop="fill" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(250).Height(250).Gravity("north").Crop("fill")).BuildImageTag("sample.jpg")
    Image filled to a width and height of 250 pixels with north gravity
  • With gravity set to south_east:
    Ruby:
    cl_image_tag("sample.jpg", :width=>250, :height=>250, :gravity=>"south_east", :crop=>"fill")
    PHP:
    cl_image_tag("sample.jpg", array("width"=>250, "height"=>250, "gravity"=>"south_east", "crop"=>"fill"))
    Python:
    CloudinaryImage("sample.jpg").image(width=250, height=250, gravity="south_east", crop="fill")
    Node.js:
    cloudinary.image("sample.jpg", {width: 250, height: 250, gravity: "south_east", crop: "fill"})
    Java:
    cloudinary.url().transformation(new Transformation().width(250).height(250).gravity("south_east").crop("fill")).imageTag("sample.jpg")
    JS:
    cl.imageTag('sample.jpg', {width: 250, height: 250, gravity: "south_east", crop: "fill"}).toHtml();
    jQuery:
    $.cloudinary.image("sample.jpg", {width: 250, height: 250, gravity: "south_east", crop: "fill"})
    React:
    <Image publicId="sample.jpg" width="250" height="250" gravity="south_east" crop="fill">
            <Transformation width=250 height=250 gravity="south_east" crop="fill" />
    </Image>
    Angular:
    <cl-image public-id="sample.jpg" width="250" height="250" gravity="south_east" crop="fill">
            <cl-transformation width=250 height=250 gravity="south_east" crop="fill" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(250).Height(250).Gravity("south_east").Crop("fill")).BuildImageTag("sample.jpg")
    Image filled to a width and height of 250 pixels with north gravity

More advanced gravity parameters include:

  • xy_center - Set the center of gravity to the given x & y coordinates.
  • face - Automatically detect the largest face in an image and make it the focus of the transformation. Any previously specified face coordinates (during upload, with the Admin API, or via the Management Console) override the automatically detected faces and are used instead. Defaults to north gravity if no face is detected or previously specified. You can also use face:auto or face:center so that the gravity will default to auto or center if no face is detected or specified.
  • faces - Same as face gravity, but detects all the faces in an image and uses the rectangle containing all face coordinates as the basis of the transformation. Any previously specified face coordinates (during upload, with the Admin API, or via the Management Console) override the automatically detected faces and are used instead. Defaults to north gravity if no faces are detected or previously specified. You can also use faces:auto or faces:center so that the gravity will default to auto or center if no faces are detected or specified.
  • face:center - Same as face gravity, but defaults to center gravity if no face is detected.
  • faces:center - Same as faces gravity, but defaults to center gravity if no face is detected.
  • auto - An intelligent algorithm analyzes and prioritizes the most prominent elements of the image to focus on. For details, see Automatic cropping
  • ocr_text - Detect all text elements in an image using the OCR Text Detection and Extraction add-on and use the detected bounding box coordinates as the basis of the transformation.
  • adv_face - Automatically detect the largest face in an image with the Advanced Facial Attribute Detection add-on and make it the focus of the transformation.
  • adv_faces - Automatically detect all faces in an image with the Advanced Facial Attribute Detection add-on and make them the focus of the transformation.
  • adv_eyes - Automatically detect all eyes in an image with the Advanced Facial Attribute Detection add-on and make them the focus of the transformation.
  • custom - Use custom coordinates that were previously specified (e.g., as part of the image upload method) and make them the focus of the transformation. Defaults to 'center' gravity if no custom coordinates have been specified.
  • custom:face - Same as custom gravity, but defaults to face gravity if no custom coordinates have been specified.
  • custom:faces - Same as custom gravity, but defaults to faces gravity if no custom coordinates have been specified.
  • custom:adv_face - Same as custom gravity, but defaults to adv_face gravity if no custom coordinates have been specified.
  • custom:adv_faces - Same as custom gravity, but defaults to adv_faces gravity if no custom coordinates have been specified.

Note: The fallback (default) values are only relevant when setting gravity for cropping modes and not when setting gravity for placing overlays. For example, if gravity is set to 'face' for placing an overlay, and no face is detected in the image, then the overlay is ignored.

Automatic cropping

Cloudinary's intelligent cropping capabilities ensure that the most interesting areas of each image are included in the resulting derived image, not only for photos with faces, but for any content type. Each image is analyzed individually to find the optimal region to focus on while cropping, and automatically detected faces (or other elements) are given higher priority while analyzing the image content (note that any custom coordinates defined will override the detection algorithm).

The Cloudinary content-aware cropping algorithm uses a combination of heuristics to automatically detect the region of interest in every image and then crop them on the fly. Automatic cropping is supported by setting the gravity transformation parameter to auto (g_auto in URLs):

  • g_auto1 - The default mode that gives higher priority to automatically detected faces (the same as g_auto:faces).
  • g_auto:[focal_gravity]1 - (e.g., g_auto:adv_face). Specific focal gravities can be specified in order to give higher priority to other auto detected regions rather than the default of giving priority to detected faces. Supported options for focal_gravity: adv_face, adv_faces, adv_eyes, body, face, and faces (default).
  • g_auto:no_faces1 - the algorithm will process the image without giving higher priority to any detected elements (e.g., auto detected faces).
  • g_auto:custom_no_override - Don't override the algorithm with the custom coordinates but give higher priority to the custom coordinates when determining the region of interest.
  • g_auto:none - Perform analysis of the image content without giving precedence to custom coordinates or higher priority to any detected element.
  • g_auto:[level]1 - (Only relevant for the thumb cropping mode). The level of aggressiveness of the cropping algorithm between 0 and 100, where 100 tries to keep more of the original image, and 0 crops more aggressively and then zooms in to image. e.g., g_auto:50, g_auto:adv_faces:0. The default is 100.

1 If custom coordinates have been specified for an image (using the Upload API or the Management Console), the cropping will be done according to them, taking the custom coordinates as-is and overriding the detection algorithm (the same as g_custom). This applies to all the g_auto options above except for g_auto:custom_no_override and g_auto:none.

Automatic cropping is supported for the fill, lfill, thumb and crop modes.

Automatic cropping with the fill mode

Keeping the most of the original image according to the requested dimensions of the derived image. Ensuring that as much as possible of the most interesting regions of the original image is included in the resulting image.

Example of portrait aspect ratio cropping, regular vs. automatic:

Original image Original Regular image thumbnail w_200,h_300,c_fill,g_center
Regular fill
Automatic image thumbnail with fill w_200,h_300,c_fill,g_auto
Automatic fill

Ruby:
cl_image_tag("basketball_in_net.jpg", :width=>200, :height=>300, :gravity=>"auto", :crop=>"fill")
PHP:
cl_image_tag("basketball_in_net.jpg", array("width"=>200, "height"=>300, "gravity"=>"auto", "crop"=>"fill"))
Python:
CloudinaryImage("basketball_in_net.jpg").image(width=200, height=300, gravity="auto", crop="fill")
Node.js:
cloudinary.image("basketball_in_net.jpg", {width: 200, height: 300, gravity: "auto", crop: "fill"})
Java:
cloudinary.url().transformation(new Transformation().width(200).height(300).gravity("auto").crop("fill")).imageTag("basketball_in_net.jpg")
JS:
cl.imageTag('basketball_in_net.jpg', {width: 200, height: 300, gravity: "auto", crop: "fill"}).toHtml();
jQuery:
$.cloudinary.image("basketball_in_net.jpg", {width: 200, height: 300, gravity: "auto", crop: "fill"})
React:
<Image publicId="basketball_in_net.jpg" width="200" height="300" gravity="auto" crop="fill">
        <Transformation width=200 height=300 gravity="auto" crop="fill" />
</Image>
Angular:
<cl-image public-id="basketball_in_net.jpg" width="200" height="300" gravity="auto" crop="fill">
        <cl-transformation width=200 height=300 gravity="auto" crop="fill" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(200).Height(300).Gravity("auto").Crop("fill")).BuildImageTag("basketball_in_net.jpg")

Example of square aspect ratio cropping, regular vs. automatic:

Original image Original Regular image thumbnail w_200,h_200,c_fill,g_center
Regular fill
Automatic image thumbnail with fill w_200,h_200,c_fill,g_auto
Automatic fill

Ruby:
cl_image_tag("face_left.jpg", :width=>200, :height=>200, :gravity=>"auto", :crop=>"fill")
PHP:
cl_image_tag("face_left.jpg", array("width"=>200, "height"=>200, "gravity"=>"auto", "crop"=>"fill"))
Python:
CloudinaryImage("face_left.jpg").image(width=200, height=200, gravity="auto", crop="fill")
Node.js:
cloudinary.image("face_left.jpg", {width: 200, height: 200, gravity: "auto", crop: "fill"})
Java:
cloudinary.url().transformation(new Transformation().width(200).height(200).gravity("auto").crop("fill")).imageTag("face_left.jpg")
JS:
cl.imageTag('face_left.jpg', {width: 200, height: 200, gravity: "auto", crop: "fill"}).toHtml();
jQuery:
$.cloudinary.image("face_left.jpg", {width: 200, height: 200, gravity: "auto", crop: "fill"})
React:
<Image publicId="face_left.jpg" width="200" height="200" gravity="auto" crop="fill">
        <Transformation width=200 height=200 gravity="auto" crop="fill" />
</Image>
Angular:
<cl-image public-id="face_left.jpg" width="200" height="200" gravity="auto" crop="fill">
        <cl-transformation width=200 height=200 gravity="auto" crop="fill" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(200).Height(200).Gravity("auto").Crop("fill")).BuildImageTag("face_left.jpg")

Automatic cropping with the lfill mode

Same as the fill mode, but only if the original image is larger than the given limit (width and height). This mode doesn't scale up the image if your requested dimensions are bigger than the original image's.

Automatic cropping with the thumb mode

Makes possible more aggressive cropping than the fill mode. This mode attempts to further zoom in and crop out less interesting image regions when relevant in order to include the most interesting objects in the resulting derived image. The automatic cropping algorithm decides whether and how aggressively to zoom-in and crop according to the content and cropping ratio of each image individually. A numerical value between 0 and 100 can be added to the g_auto parameter in order to advise the algorithm regarding the desired aggressiveness level (e.g., g_auto:0 for the most aggressive thumb cropping).

Example of a square thumbnail, regular vs. automatic cropping:

Original Original Regular image thumbnail c_thumb,g_center
Regular thumbnail
Automatic image thumbnail c_thumb,g_auto
Automatic thumbnail
Automatic image thumbnail with the most aggressive cropping c_thumb,g_auto:0
Automatic thumbnail -
most aggressive

Ruby:
cl_image_tag("sunset_shoes.jpg", :width=>150, :height=>150, :gravity=>"auto:0", :crop=>"thumb")
PHP:
cl_image_tag("sunset_shoes.jpg", array("width"=>150, "height"=>150, "gravity"=>"auto:0", "crop"=>"thumb"))
Python:
CloudinaryImage("sunset_shoes.jpg").image(width=150, height=150, gravity="auto:0", crop="thumb")
Node.js:
cloudinary.image("sunset_shoes.jpg", {width: 150, height: 150, gravity: "auto:0", crop: "thumb"})
Java:
cloudinary.url().transformation(new Transformation().width(150).height(150).gravity("auto:0").crop("thumb")).imageTag("sunset_shoes.jpg")
JS:
cl.imageTag('sunset_shoes.jpg', {width: 150, height: 150, gravity: "auto:0", crop: "thumb"}).toHtml();
jQuery:
$.cloudinary.image("sunset_shoes.jpg", {width: 150, height: 150, gravity: "auto:0", crop: "thumb"})
React:
<Image publicId="sunset_shoes.jpg" width="150" height="150" gravity="auto:0" crop="thumb">
        <Transformation width=150 height=150 gravity="auto:0" crop="thumb" />
</Image>
Angular:
<cl-image public-id="sunset_shoes.jpg" width="150" height="150" gravity="auto:0" crop="thumb">
        <cl-transformation width=150 height=150 gravity="auto:0" crop="thumb" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(150).Height(150).Gravity("auto:0").Crop("thumb")).BuildImageTag("sunset_shoes.jpg")

Automatic cropping with the crop mode

Crop a region of exactly the given width and height out of the original image while automatically focusing on the most interesting region of the original image that fits within the required dimensions. The portion of the interesting area depends on the resolution of the original image. The crop mode is less useful than the fill, lfill, and thumb modes, as it is only practical to use when both the dimensions of the original image and the size of the interesting region are already known.

Example of a square crop, regular vs. auto cropping:

Original image Original Regular image thumbnail c_crop,g_center
Regular crop
Automatic image thumbnail with crop c_crop,g_auto
Automatic crop

Ruby:
cl_image_tag("fat_cat.jpg", :width=>200, :height=>200, :gravity=>"auto", :crop=>"crop")
PHP:
cl_image_tag("fat_cat.jpg", array("width"=>200, "height"=>200, "gravity"=>"auto", "crop"=>"crop"))
Python:
CloudinaryImage("fat_cat.jpg").image(width=200, height=200, gravity="auto", crop="crop")
Node.js:
cloudinary.image("fat_cat.jpg", {width: 200, height: 200, gravity: "auto", crop: "crop"})
Java:
cloudinary.url().transformation(new Transformation().width(200).height(200).gravity("auto").crop("crop")).imageTag("fat_cat.jpg")
JS:
cl.imageTag('fat_cat.jpg', {width: 200, height: 200, gravity: "auto", crop: "crop"}).toHtml();
jQuery:
$.cloudinary.image("fat_cat.jpg", {width: 200, height: 200, gravity: "auto", crop: "crop"})
React:
<Image publicId="fat_cat.jpg" width="200" height="200" gravity="auto" crop="crop">
        <Transformation width=200 height=200 gravity="auto" crop="crop" />
</Image>
Angular:
<cl-image public-id="fat_cat.jpg" width="200" height="200" gravity="auto" crop="crop">
        <cl-transformation width=200 height=200 gravity="auto" crop="crop" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(200).Height(200).Gravity("auto").Crop("crop")).BuildImageTag("fat_cat.jpg")

Face detection based transformations

Cloudinary provides face detection algorithms for automatically applying transformations according to the detected faces within an image. This section consists of the following topics:

Face detection based cropping

Cloudinary supports built-in face detection capabilities that allow you to intelligently crop your images. To automatically crop an image so that the detected face(s) is used as the center of the derived picture, set the gravity parameter to one of the following values:

  • face - the region of the image that includes the single largest face (g_face for URLs).
  • faces - the region of the image that includes all the faces detected (g_faces for URLs).

For example, the image below of a nice woman with a Blue Morpho butterfly was uploaded to Cloudinary:

Ruby:
cl_image_tag("butterfly.jpg")
PHP:
cl_image_tag("butterfly.jpg")
Python:
CloudinaryImage("butterfly.jpg").image()
Node.js:
cloudinary.image("butterfly.jpg")
Java:
cloudinary.url().imageTag("butterfly.jpg")
JS:
cl.imageTag('butterfly.jpg').toHtml();
jQuery:
$.cloudinary.image("butterfly.jpg")
React:
<Image publicId="butterfly.jpg" >

</Image>
Angular:
<cl-image public-id="butterfly.jpg" >

</cl-image>
.Net:
cloudinary.Api.UrlImgUp.BuildImageTag("butterfly.jpg")
butterfly.jpg uploaded to Cloudinary

To create a 200x200 version with the fill cropping mode to keep as much as possible of the original image, and using the default center gravity without face detection (for comparison):

Ruby:
cl_image_tag("butterfly.jpg", :width=>200, :height=>200, :crop=>"fill")
PHP:
cl_image_tag("butterfly.jpg", array("width"=>200, "height"=>200, "crop"=>"fill"))
Python:
CloudinaryImage("butterfly.jpg").image(width=200, height=200, crop="fill")
Node.js:
cloudinary.image("butterfly.jpg", {width: 200, height: 200, crop: "fill"})
Java:
cloudinary.url().transformation(new Transformation().width(200).height(200).crop("fill")).imageTag("butterfly.jpg")
JS:
cl.imageTag('butterfly.jpg', {width: 200, height: 200, crop: "fill"}).toHtml();
jQuery:
$.cloudinary.image("butterfly.jpg", {width: 200, height: 200, crop: "fill"})
React:
<Image publicId="butterfly.jpg" width="200" height="200" crop="fill">
        <Transformation width=200 height=200 crop="fill" />
</Image>
Angular:
<cl-image public-id="butterfly.jpg" width="200" height="200" crop="fill">
        <cl-transformation width=200 height=200 crop="fill" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(200).Height(200).Crop("fill")).BuildImageTag("butterfly.jpg")
200x200 filled without face detection

Now adding the face gravity parameter to correctly fill the requested dimensions:

Ruby:
cl_image_tag("butterfly.jpg", :width=>200, :height=>200, :gravity=>"face", :crop=>"fill")
PHP:
cl_image_tag("butterfly.jpg", array("width"=>200, "height"=>200, "gravity"=>"face", "crop"=>"fill"))
Python:
CloudinaryImage("butterfly.jpg").image(width=200, height=200, gravity="face", crop="fill")
Node.js:
cloudinary.image("butterfly.jpg", {width: 200, height: 200, gravity: "face", crop: "fill"})
Java:
cloudinary.url().transformation(new Transformation().width(200).height(200).gravity("face").crop("fill")).imageTag("butterfly.jpg")
JS:
cl.imageTag('butterfly.jpg', {width: 200, height: 200, gravity: "face", crop: "fill"}).toHtml();
jQuery:
$.cloudinary.image("butterfly.jpg", {width: 200, height: 200, gravity: "face", crop: "fill"})
React:
<Image publicId="butterfly.jpg" width="200" height="200" gravity="face" crop="fill">
        <Transformation width=200 height=200 gravity="face" crop="fill" />
</Image>
Angular:
<cl-image public-id="butterfly.jpg" width="200" height="200" gravity="face" crop="fill">
        <cl-transformation width=200 height=200 gravity="face" crop="fill" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(200).Height(200).Gravity("face").Crop("fill")).BuildImageTag("butterfly.jpg")
200x200 filled with face detection

In order to create a 200x200 thumbnail focused on the face of the woman, simply select the thumb crop mode and face gravity:

Ruby:
cl_image_tag("butterfly.jpg", :width=>200, :height=>200, :gravity=>"face", :crop=>"thumb")
PHP:
cl_image_tag("butterfly.jpg", array("width"=>200, "height"=>200, "gravity"=>"face", "crop"=>"thumb"))
Python:
CloudinaryImage("butterfly.jpg").image(width=200, height=200, gravity="face", crop="thumb")
Node.js:
cloudinary.image("butterfly.jpg", {width: 200, height: 200, gravity: "face", crop: "thumb"})
Java:
cloudinary.url().transformation(new Transformation().width(200).height(200).gravity("face").crop("thumb")).imageTag("butterfly.jpg")
JS:
cl.imageTag('butterfly.jpg', {width: 200, height: 200, gravity: "face", crop: "thumb"}).toHtml();
jQuery:
$.cloudinary.image("butterfly.jpg", {width: 200, height: 200, gravity: "face", crop: "thumb"})
React:
<Image publicId="butterfly.jpg" width="200" height="200" gravity="face" crop="thumb">
        <Transformation width=200 height=200 gravity="face" crop="thumb" />
</Image>
Angular:
<cl-image public-id="butterfly.jpg" width="200" height="200" gravity="face" crop="thumb">
        <cl-transformation width=200 height=200 gravity="face" crop="thumb" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(200).Height(200).Gravity("face").Crop("thumb")).BuildImageTag("butterfly.jpg")
90x90 thumb focused on the face of the woman

You can also automatically crop to the region defined by face detection without resizing the original image. The following example uses the crop mode together with face gravity for cropping the original image to the face of the woman:

Ruby:
cl_image_tag("butterfly.jpg", :gravity=>"face", :crop=>"crop")
PHP:
cl_image_tag("butterfly.jpg", array("gravity"=>"face", "crop"=>"crop"))
Python:
CloudinaryImage("butterfly.jpg").image(gravity="face", crop="crop")
Node.js:
cloudinary.image("butterfly.jpg", {gravity: "face", crop: "crop"})
Java:
cloudinary.url().transformation(new Transformation().gravity("face").crop("crop")).imageTag("butterfly.jpg")
JS:
cl.imageTag('butterfly.jpg', {gravity: "face", crop: "crop"}).toHtml();
jQuery:
$.cloudinary.image("butterfly.jpg", {gravity: "face", crop: "crop"})
React:
<Image publicId="butterfly.jpg" gravity="face" crop="crop">
        <Transformation gravity="face" crop="crop" />
</Image>
Angular:
<cl-image public-id="butterfly.jpg" gravity="face" crop="crop">
        <cl-transformation gravity="face" crop="crop" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Gravity("face").Crop("crop")).BuildImageTag("butterfly.jpg")
90x90 cropped to the face of the woman

For examples with multiple faces, the following image, showing a nice couple, was uploaded to Cloudinary:

Ruby:
cl_image_tag("couple.jpg")
PHP:
cl_image_tag("couple.jpg")
Python:
CloudinaryImage("couple.jpg").image()
Node.js:
cloudinary.image("couple.jpg")
Java:
cloudinary.url().imageTag("couple.jpg")
JS:
cl.imageTag('couple.jpg').toHtml();
jQuery:
$.cloudinary.image("couple.jpg")
React:
<Image publicId="couple.jpg" >

</Image>
Angular:
<cl-image public-id="couple.jpg" >

</cl-image>
.Net:
cloudinary.Api.UrlImgUp.BuildImageTag("couple.jpg")
couple.jpg uploaded to Cloudinary

You can specify the thumb crop mode and face gravity to create a 150x150 thumbnail centered on the face of only the biggest face in the image:

Ruby:
cl_image_tag("couple.jpg", :width=>150, :height=>150, :gravity=>"face", :crop=>"thumb")
PHP:
cl_image_tag("couple.jpg", array("width"=>150, "height"=>150, "gravity"=>"face", "crop"=>"thumb"))
Python:
CloudinaryImage("couple.jpg").image(width=150, height=150, gravity="face", crop="thumb")
Node.js:
cloudinary.image("couple.jpg", {width: 150, height: 150, gravity: "face", crop: "thumb"})
Java:
cloudinary.url().transformation(new Transformation().width(150).height(150).gravity("face").crop("thumb")).imageTag("couple.jpg")
JS:
cl.imageTag('couple.jpg', {width: 150, height: 150, gravity: "face", crop: "thumb"}).toHtml();
jQuery:
$.cloudinary.image("couple.jpg", {width: 150, height: 150, gravity: "face", crop: "thumb"})
React:
<Image publicId="couple.jpg" width="150" height="150" gravity="face" crop="thumb">
        <Transformation width=150 height=150 gravity="face" crop="thumb" />
</Image>
Angular:
<cl-image public-id="couple.jpg" width="150" height="150" gravity="face" crop="thumb">
        <cl-transformation width=150 height=150 gravity="face" crop="thumb" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(150).Height(150).Gravity("face").Crop("thumb")).BuildImageTag("couple.jpg")
150x150 thumb focused on the biggest face in the image

In order to create a thumbnail focusing on the faces of both of them, simply specify faces as the gravity:

Ruby:
cl_image_tag("couple.jpg", :width=>115, :height=>135, :gravity=>"faces", :crop=>"thumb")
PHP:
cl_image_tag("couple.jpg", array("width"=>115, "height"=>135, "gravity"=>"faces", "crop"=>"thumb"))
Python:
CloudinaryImage("couple.jpg").image(width=115, height=135, gravity="faces", crop="thumb")
Node.js:
cloudinary.image("couple.jpg", {width: 115, height: 135, gravity: "faces", crop: "thumb"})
Java:
cloudinary.url().transformation(new Transformation().width(115).height(135).gravity("faces").crop("thumb")).imageTag("couple.jpg")
JS:
cl.imageTag('couple.jpg', {width: 115, height: 135, gravity: "faces", crop: "thumb"}).toHtml();
jQuery:
$.cloudinary.image("couple.jpg", {width: 115, height: 135, gravity: "faces", crop: "thumb"})
React:
<Image publicId="couple.jpg" width="115" height="135" gravity="faces" crop="thumb">
        <Transformation width=115 height=135 gravity="faces" crop="thumb" />
</Image>
Angular:
<cl-image public-id="couple.jpg" width="115" height="135" gravity="faces" crop="thumb">
        <cl-transformation width=115 height=135 gravity="faces" crop="thumb" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(115).Height(135).Gravity("faces").Crop("thumb")).BuildImageTag("couple.jpg")
thumb focused on all faces in the image

You can also use the fill cropping mode together with faces gravity to correctly fill an image with your desired dimensions:

Ruby:
cl_image_tag("couple.jpg", :width=>100, :height=>150, :gravity=>"faces", :crop=>"fill")
PHP:
cl_image_tag("couple.jpg", array("width"=>100, "height"=>150, "gravity"=>"faces", "crop"=>"fill"))
Python:
CloudinaryImage("couple.jpg").image(width=100, height=150, gravity="faces", crop="fill")
Node.js:
cloudinary.image("couple.jpg", {width: 100, height: 150, gravity: "faces", crop: "fill"})
Java:
cloudinary.url().transformation(new Transformation().width(100).height(150).gravity("faces").crop("fill")).imageTag("couple.jpg")
JS:
cl.imageTag('couple.jpg', {width: 100, height: 150, gravity: "faces", crop: "fill"}).toHtml();
jQuery:
$.cloudinary.image("couple.jpg", {width: 100, height: 150, gravity: "faces", crop: "fill"})
React:
<Image publicId="couple.jpg" width="100" height="150" gravity="faces" crop="fill">
        <Transformation width=100 height=150 gravity="faces" crop="fill" />
</Image>
Angular:
<cl-image public-id="couple.jpg" width="100" height="150" gravity="faces" crop="fill">
        <cl-transformation width=100 height=150 gravity="faces" crop="fill" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(100).Height(150).Gravity("faces").Crop("fill")).BuildImageTag("couple.jpg")
60x150 filled to focus on all faces in the image

Position overlays on detected faces

To automatically position an overlay over the detected face(s) in an image, set the gravity parameter to one of the following values:

  • face - places an overlay over the single largest face in the image (g_face for URLs).
  • faces - places an overlay over each of the faces in the image (g_faces for URLs).

For example, adding an overlay of the golden_star image over both of the faces detected in the young_couples image, where each star is resized to the same width as the detected face with the region_relative flag:

Ruby:
cl_image_tag("young_couple.jpg", :overlay=>"golden_star", :gravity=>"faces", :width=>1.0, :flags=>"region_relative")
PHP:
cl_image_tag("young_couple.jpg", array("overlay"=>"golden_star", "gravity"=>"faces", "width"=>1.0, "flags"=>"region_relative"))
Python:
CloudinaryImage("young_couple.jpg").image(overlay="golden_star", gravity="faces", width=1.0, flags="region_relative")
Node.js:
cloudinary.image("young_couple.jpg", {overlay: "golden_star", gravity: "faces", width: 1.0, flags: "region_relative"})
Java:
cloudinary.url().transformation(new Transformation().overlay("golden_star").gravity("faces").width(1.0).flags("region_relative")).imageTag("young_couple.jpg")
JS:
cl.imageTag('young_couple.jpg', {overlay: "golden_star", gravity: "faces", width: 1.0, flags: "region_relative"}).toHtml();
jQuery:
$.cloudinary.image("young_couple.jpg", {overlay: "golden_star", gravity: "faces", width: 1.0, flags: "region_relative"})
React:
<Image publicId="young_couple.jpg" overlay="golden_star" gravity="faces" width="1.0" flags="region_relative">
        <Transformation overlay="golden_star" gravity="faces" width=1.0 flags="region_relative" />
</Image>
Angular:
<cl-image public-id="young_couple.jpg" overlay="golden_star" gravity="faces" width="1.0" flags="region_relative">
        <cl-transformation overlay="golden_star" gravity="faces" width=1.0 flags="region_relative" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Overlay("golden_star").Gravity("faces").Width(1.0).Flags("region_relative")).BuildImageTag("young_couple.jpg")
Image with overlay placed over faces

Note: When gravity is set to one of the facial detection values and no face is detected in the image, then no overlay is placed at all.

Effects with face detection

To apply a blur or pixelation effect to the automatically detected faces in an image, use the effect parameter and set it to one of the following values:

  • blur_faces - Automatically blur all detected faces in the image: the strength of the blur effect is determined by an optional extra value (Range: 1 to 2000, Default: 500). For example, e_blur_faces:100 uses a mild blur effect with a strength of 100.
  • pixelate_faces - Automatically pixelate all detected faces in the image. The width of the pixelation squares is determined by an optional extra value (Range: 1 to 200, Default: 5). For example, e_pixelate_faces:3 uses pixelation squares 3 pixels wide.

For example, to automatically pixelate both of the faces detected in the young_couples image with pixelation squares 9 pixels wide:

Ruby:
cl_image_tag("young_couple.jpg", :effect=>"pixelate_faces:9")
PHP:
cl_image_tag("young_couple.jpg", array("effect"=>"pixelate_faces:9"))
Python:
CloudinaryImage("young_couple.jpg").image(effect="pixelate_faces:9")
Node.js:
cloudinary.image("young_couple.jpg", {effect: "pixelate_faces:9"})
Java:
cloudinary.url().transformation(new Transformation().effect("pixelate_faces:9")).imageTag("young_couple.jpg")
JS:
cl.imageTag('young_couple.jpg', {effect: "pixelate_faces:9"}).toHtml();
jQuery:
$.cloudinary.image("young_couple.jpg", {effect: "pixelate_faces:9"})
React:
<Image publicId="young_couple.jpg" effect="pixelate_faces:9">
        <Transformation effect="pixelate_faces:9" />
</Image>
Angular:
<cl-image public-id="young_couple.jpg" effect="pixelate_faces:9">
        <cl-transformation effect="pixelate_faces:9" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Effect("pixelate_faces:9")).BuildImageTag("young_couple.jpg")
Image with faces blurred

Advanced facial attributes detection

With the Advanced Facial Attributes Detection add-on, you can extend the Cloudinary built-in features that involve semantic photo data extraction, image cropping and the positioning of image overlays. When using the add-on, your images are further processed and additional advanced face attributes are automatically extracted. Cloudinary can then use these additional details to smartly crop, position, rotate and overlay images according to the position of the detected faces or eyes.

The advanced facial detection is applied by setting the gravity parameter to one of the following values:

  • adv_face - detects the single largest face in the image (g_adv_face for URLs).
  • adv_faces - detects all of the faces in the image (g_adv_faces for URLs).
  • adv_eyes - detects all the pairs of eyes in the image (g_adv_eyes for URLs).

For example, to automatically overlay the image glasses over the detected eyes in the couples image. The glasses are resized to 170% the width of the detected eyes by adding the region_relative flag:

Ruby:
cl_image_tag("coupled.jpg", :flags=>"region_relative", :gravity=>"adv_eyes", :overlay=>"glasses", :width=>1.7)
PHP:
cl_image_tag("coupled.jpg", array("flags"=>"region_relative", "gravity"=>"adv_eyes", "overlay"=>"glasses", "width"=>1.7))
Python:
CloudinaryImage("coupled.jpg").image(flags="region_relative", gravity="adv_eyes", overlay="glasses", width=1.7)
Node.js:
cloudinary.image("coupled.jpg", {flags: "region_relative", gravity: "adv_eyes", overlay: "glasses", width: 1.7})
Java:
cloudinary.url().transformation(new Transformation().flags("region_relative").gravity("adv_eyes").overlay("glasses").width(1.7)).imageTag("coupled.jpg")
JS:
cl.imageTag('coupled.jpg', {flags: "region_relative", gravity: "adv_eyes", overlay: "glasses", width: 1.7}).toHtml();
jQuery:
$.cloudinary.image("coupled.jpg", {flags: "region_relative", gravity: "adv_eyes", overlay: "glasses", width: 1.7})
React:
<Image publicId="coupled.jpg" flags="region_relative" gravity="adv_eyes" overlay="glasses" width="1.7">
        <Transformation flags="region_relative" gravity="adv_eyes" overlay="glasses" width=1.7 />
</Image>
Angular:
<cl-image public-id="coupled.jpg" flags="region_relative" gravity="adv_eyes" overlay="glasses" width="1.7">
        <cl-transformation flags="region_relative" gravity="adv_eyes" overlay="glasses" width=1.7 />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Flags("region_relative").Gravity("adv_eyes").Overlay("glasses").Width(1.7)).BuildImageTag("coupled.jpg")
Automatically placed glasses on detected faces

See the Advanced Facial Attributes Detection documentation for more information and examples on using the add-on.

Zoom level

When using either the crop or thumb cropping modes and setting the gravity parameter to one of the face detection values, the resulting image is delivered at a default zoom level. To control how much of the original image surrounding the face to keep, use the zoom parameter (z for URLs). This parameter accepts a decimal value that sets the new zoom level as a multiplier of the default zoom setting: a value less than 1.0 zooms out and a value greater than 1.0 zooms in. For example, z_0.5 halves the default zoom to 50% and zooms out to include more of the background around the face, while z_2.0 doubles the default zoom to 200% and zooms in to include less of the background around the face.

Examples with the uploaded image called woman:

  • Original image (scaled down):
    Ruby:
    cl_image_tag("woman.jpg")
    PHP:
    cl_image_tag("woman.jpg")
    Python:
    CloudinaryImage("woman.jpg").image()
    Node.js:
    cloudinary.image("woman.jpg")
    Java:
    cloudinary.url().imageTag("woman.jpg")
    JS:
    cl.imageTag('woman.jpg').toHtml();
    jQuery:
    $.cloudinary.image("woman.jpg")
    React:
    <Image publicId="woman.jpg" >
    
    </Image>
    Angular:
    <cl-image public-id="woman.jpg" >
    
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.BuildImageTag("woman.jpg")
    Original image
  • Cropped with face detection and default zoom:
    Ruby:
    cl_image_tag("woman.jpg", :gravity=>"face", :crop=>"crop")
    PHP:
    cl_image_tag("woman.jpg", array("gravity"=>"face", "crop"=>"crop"))
    Python:
    CloudinaryImage("woman.jpg").image(gravity="face", crop="crop")
    Node.js:
    cloudinary.image("woman.jpg", {gravity: "face", crop: "crop"})
    Java:
    cloudinary.url().transformation(new Transformation().gravity("face").crop("crop")).imageTag("woman.jpg")
    JS:
    cl.imageTag('woman.jpg', {gravity: "face", crop: "crop"}).toHtml();
    jQuery:
    $.cloudinary.image("woman.jpg", {gravity: "face", crop: "crop"})
    React:
    <Image publicId="woman.jpg" gravity="face" crop="crop">
            <Transformation gravity="face" crop="crop" />
    </Image>
    Angular:
    <cl-image public-id="woman.jpg" gravity="face" crop="crop">
            <cl-transformation gravity="face" crop="crop" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Gravity("face").Crop("crop")).BuildImageTag("woman.jpg")
    Cropped with face detection and default zoom
  • Cropped with face detection and zoom set to 130%:
    Ruby:
    cl_image_tag("woman.jpg", :gravity=>"face", :zoom=>1.3, :crop=>"crop")
    PHP:
    cl_image_tag("woman.jpg", array("gravity"=>"face", "zoom"=>1.3, "crop"=>"crop"))
    Python:
    CloudinaryImage("woman.jpg").image(gravity="face", zoom=1.3, crop="crop")
    Node.js:
    cloudinary.image("woman.jpg", {gravity: "face", zoom: 1.3, crop: "crop"})
    Java:
    cloudinary.url().transformation(new Transformation().gravity("face").zoom(1.3).crop("crop")).imageTag("woman.jpg")
    JS:
    cl.imageTag('woman.jpg', {gravity: "face", zoom: 1.3, crop: "crop"}).toHtml();
    jQuery:
    $.cloudinary.image("woman.jpg", {gravity: "face", zoom: 1.3, crop: "crop"})
    React:
    <Image publicId="woman.jpg" gravity="face" zoom="1.3" crop="crop">
            <Transformation gravity="face" zoom=1.3 crop="crop" />
    </Image>
    Angular:
    <cl-image public-id="woman.jpg" gravity="face" zoom="1.3" crop="crop">
            <cl-transformation gravity="face" zoom=1.3 crop="crop" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Gravity("face").Zoom(1.3).Crop("crop")).BuildImageTag("woman.jpg")
    Cropped with face detection and zoom set to 120%
  • 150x150 thumbnail with face detection and default zoom:
    Ruby:
    cl_image_tag("woman.jpg", :gravity=>"face", :width=>150, :height=>150, :crop=>"thumb")
    PHP:
    cl_image_tag("woman.jpg", array("gravity"=>"face", "width"=>150, "height"=>150, "crop"=>"thumb"))
    Python:
    CloudinaryImage("woman.jpg").image(gravity="face", width=150, height=150, crop="thumb")
    Node.js:
    cloudinary.image("woman.jpg", {gravity: "face", width: 150, height: 150, crop: "thumb"})
    Java:
    cloudinary.url().transformation(new Transformation().gravity("face").width(150).height(150).crop("thumb")).imageTag("woman.jpg")
    JS:
    cl.imageTag('woman.jpg', {gravity: "face", width: 150, height: 150, crop: "thumb"}).toHtml();
    jQuery:
    $.cloudinary.image("woman.jpg", {gravity: "face", width: 150, height: 150, crop: "thumb"})
    React:
    <Image publicId="woman.jpg" gravity="face" width="150" height="150" crop="thumb">
            <Transformation gravity="face" width=150 height=150 crop="thumb" />
    </Image>
    Angular:
    <cl-image public-id="woman.jpg" gravity="face" width="150" height="150" crop="thumb">
            <cl-transformation gravity="face" width=150 height=150 crop="thumb" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Gravity("face").Width(150).Height(150).Crop("thumb")).BuildImageTag("woman.jpg")
    150x150 thumbnail with face detection and default zoom
  • 150x150 thumbnail with face detection and zoom set to 70%:
    Ruby:
    cl_image_tag("woman.jpg", :gravity=>"face", :width=>150, :height=>150, :zoom=>0.7, :crop=>"thumb")
    PHP:
    cl_image_tag("woman.jpg", array("gravity"=>"face", "width"=>150, "height"=>150, "zoom"=>0.7, "crop"=>"thumb"))
    Python:
    CloudinaryImage("woman.jpg").image(gravity="face", width=150, height=150, zoom=0.7, crop="thumb")
    Node.js:
    cloudinary.image("woman.jpg", {gravity: "face", width: 150, height: 150, zoom: 0.7, crop: "thumb"})
    Java:
    cloudinary.url().transformation(new Transformation().gravity("face").width(150).height(150).zoom(0.7).crop("thumb")).imageTag("woman.jpg")
    JS:
    cl.imageTag('woman.jpg', {gravity: "face", width: 150, height: 150, zoom: 0.7, crop: "thumb"}).toHtml();
    jQuery:
    $.cloudinary.image("woman.jpg", {gravity: "face", width: 150, height: 150, zoom: 0.7, crop: "thumb"})
    React:
    <Image publicId="woman.jpg" gravity="face" width="150" height="150" zoom="0.7" crop="thumb">
            <Transformation gravity="face" width=150 height=150 zoom=0.7 crop="thumb" />
    </Image>
    Angular:
    <cl-image public-id="woman.jpg" gravity="face" width="150" height="150" zoom="0.7" crop="thumb">
            <cl-transformation gravity="face" width=150 height=150 zoom=0.7 crop="thumb" />
    </cl-image>
    .Net:
    cloudinary.Api.UrlImgUp.Transform(new Transformation().Gravity("face").Width(150).Height(150).Zoom(0.7).Crop("thumb")).BuildImageTag("woman.jpg")
    150x150 thumbnail with face detection and default zoom

For more examples on using the zoom parameter see the article on How to control the zoom level with automatic face detection based image cropping.

Image format conversion

Images can be uploaded to Cloudinary in various formats, and you can easily convert these images to other formats for displaying in your web site or application. Examples of situations where you might want to change the delivered image format:

  • Delivering JPEGs for photos that you want to load quickly (or WebP if your users are on a Chrome browser or on a mobile app you control).
  • Delivering a GIF if the image contains a drawing with only a few colors.
  • Delivering a PNG (24 bit) for high quality illustrations with a transparent background.

You can dynamically convert images to your desired format. Cloudinary currently supports the following image formats:

Format Extensions Supported for Upload Supported for Transformations
JPEG (Joint Photographic Experts Group) .jpg, .jpe, .jpeg Yes Yes
JPEG 2000 (JPEG 2000) .jpc, .jp2, .j2k Yes Yes
JPEG XR (JPEG eXtended Range) .wdp, .jxr, .hdp Yes Yes
PNG (Portable Network Graphics) .png Yes Yes
GIF (Graphics Interchange Format) .gif Yes Yes
animated GIF .gif Yes Yes
WebP .webp Yes Yes
animated WebP .webp Yes Yes
BMP (BitMaP image format) .bmp Yes Yes
TIFF (Tagged Image File Format) .tif, .tiff Yes Yes
ICO (ICOn image format) .ico Yes Yes
PDF (Portable Document Format) .pdf Yes Yes
EPS (Encapsulated PostScript) .ps, .ept, .eps, .eps3 Yes No
PSD (PhotoShop Document) .psd Yes Yes
SVG (Scalable Vector Graphics) .svg Yes No
AI (Adobe Illustrator) .ai Yes No
DjVu .djvu Yes No
FLIF (Free Lossless Image Format) .flif Yes Yes
TARGA (Truevision TGA) .tga Yes Yes

To deliver images in a different format simply specify the new format as the file extension of the delivery URL. When using our SDKs you can either specify the new format as an extension to the resource name or use the format parameter.

For example, to display a GIF version of the uploaded sample JPEG file:

Ruby:
cl_image_tag("sample.gif")
PHP:
cl_image_tag("sample.gif")
Python:
CloudinaryImage("sample.gif").image()
Node.js:
cloudinary.image("sample.gif")
Java:
cloudinary.url().imageTag("sample.gif")
JS:
cl.imageTag('sample.gif').toHtml();
jQuery:
$.cloudinary.image("sample.gif")
React:
<Image publicId="sample.gif" >

</Image>
Angular:
<cl-image public-id="sample.gif" >

</cl-image>
.Net:
cloudinary.Api.UrlImgUp.BuildImageTag("sample.gif")
Image converted to gif

You can easily combine other image transformations with format conversion. Just make sure the format you use is supported for transformations, as per the table above. For example, to deliver a scaled down 150x100 GIF version of the sample image:

Ruby:
cl_image_tag("sample.gif", :width=>150, :height=>100, :crop=>"scale")
PHP:
cl_image_tag("sample.gif", array("width"=>150, "height"=>100, "crop"=>"scale"))
Python:
CloudinaryImage("sample.gif").image(width=150, height=100, crop="scale")
Node.js:
cloudinary.image("sample.gif", {width: 150, height: 100, crop: "scale"})
Java:
cloudinary.url().transformation(new Transformation().width(150).height(100).crop("scale")).imageTag("sample.gif")
JS:
cl.imageTag('sample.gif', {width: 150, height: 100, crop: "scale"}).toHtml();
jQuery:
$.cloudinary.image("sample.gif", {width: 150, height: 100, crop: "scale"})
React:
<Image publicId="sample.gif" width="150" height="100" crop="scale">
        <Transformation width=150 height=100 crop="scale" />
</Image>
Angular:
<cl-image public-id="sample.gif" width="150" height="100" crop="scale">
        <cl-transformation width=150 height=100 crop="scale" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(150).Height(100).Crop("scale")).BuildImageTag("sample.gif")
Image scaled down to 150x100 gif

Note: If the file extension is omitted from the delivery URL then the file is delivered in the originally uploaded format.

Fetch format

Another option for changing the format is to explicitly call the fetch_format parameter (f in URLs). This can be useful in situations where you cannot change the file extension, for example, when fetching remote images that already have a different file extension (format) as part of their URLs.

For example, to fetch a remote image from Wikimedia in JPEG format, and deliver the image in PNG format (also scaled down to a width of 400 pixels):

Ruby:
cl_image_tag("http://upload.wikimedia.org/wikipedia/commons/4/46/Jennifer_Lawrence_at_the_83rd_Academy_Awards.jpg", :width=>400, :crop=>"scale", :format=>"png", :type=>"fetch")
PHP:
cl_image_tag("http://upload.wikimedia.org/wikipedia/commons/4/46/Jennifer_Lawrence_at_the_83rd_Academy_Awards.jpg", array("width"=>400, "crop"=>"scale", "format"=>"png", "type"=>"fetch"))
Python:
CloudinaryImage("http://upload.wikimedia.org/wikipedia/commons/4/46/Jennifer_Lawrence_at_the_83rd_Academy_Awards.jpg").image(width=400, crop="scale", format="png", type="fetch")
Node.js:
cloudinary.image("http://upload.wikimedia.org/wikipedia/commons/4/46/Jennifer_Lawrence_at_the_83rd_Academy_Awards.jpg", {width: 400, crop: "scale", format: "png", type: "fetch"})
Java:
cloudinary.url().transformation(new Transformation().width(400).crop("scale")).format("png").type("fetch").imageTag("http://upload.wikimedia.org/wikipedia/commons/4/46/Jennifer_Lawrence_at_the_83rd_Academy_Awards.jpg")
JS:
cl.imageTag('http://upload.wikimedia.org/wikipedia/commons/4/46/Jennifer_Lawrence_at_the_83rd_Academy_Awards.jpg', {width: 400, crop: "scale", format: "png", type: "fetch"}).toHtml();
jQuery:
$.cloudinary.image("http://upload.wikimedia.org/wikipedia/commons/4/46/Jennifer_Lawrence_at_the_83rd_Academy_Awards.jpg", {width: 400, crop: "scale", format: "png", type: "fetch"})
React:
<Image publicId="http://upload.wikimedia.org/wikipedia/commons/4/46/Jennifer_Lawrence_at_the_83rd_Academy_Awards.jpg" width="400" crop="scale" format="png" type="fetch">
        <Transformation width=400 crop="scale" />
</Image>
Angular:
<cl-image public-id="http://upload.wikimedia.org/wikipedia/commons/4/46/Jennifer_Lawrence_at_the_83rd_Academy_Awards.jpg" width="400" crop="scale" format="png" type="fetch">
        <cl-transformation width=400 crop="scale" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(400).Crop("scale")).Format("png").Type("fetch").BuildImageTag("http://upload.wikimedia.org/wikipedia/commons/4/46/Jennifer_Lawrence_at_the_83rd_Academy_Awards.jpg")
Jennifer Lawrence fetched from Wikimedia and delivered as a PNG

Automatic format selection

You can also use the fetch_format feature to save bandwidth and optimize delivery time by automatically delivering images as WebP to Chrome browsers or JPEG-XR to Internet Explorer browsers. Simply set the value to auto and the best format will be delivered to the supported browser. If a browser does not support either of these formats then the image is delivered in the format specified by the file extension.

For example, the uploaded jpg image named sample scaled down to a width of 500 pixels and delivered as WebP to Chrome browsers (22.4 KB), JPEG-XR to Internet Explorer browsers (48 KB), or as a regular JPEG (57.5 KB) to browsers that support neither format:

Ruby:
cl_image_tag("sample.jpg", :width=>500, :fetch_format=>:auto, :crop=>"scale")
PHP:
cl_image_tag("sample.jpg", array("width"=>500, "fetch_format"=>"auto", "crop"=>"scale"))
Python:
CloudinaryImage("sample.jpg").image(width=500, fetch_format="auto", crop="scale")
Node.js:
cloudinary.image("sample.jpg", {width: 500, fetch_format: "auto", crop: "scale"})
Java:
cloudinary.url().transformation(new Transformation().width(500).fetchFormat("auto").crop("scale")).imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg', {width: 500, fetch_format: "auto", crop: "scale"}).toHtml();
jQuery:
$.cloudinary.image("sample.jpg", {width: 500, fetch_format: "auto", crop: "scale"})
React:
<Image publicId="sample.jpg" width="500" fetch_format="auto" crop="scale">
        <Transformation width=500 fetch_format=:auto crop="scale" />
</Image>
Angular:
<cl-image public-id="sample.jpg" width="500" fetch_format="auto" crop="scale">
        <cl-transformation width=500 fetch_format=:auto crop="scale" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Width(500).FetchFormat("auto").Crop("scale")).BuildImageTag("sample.jpg")
Image delivered with f_auto

Notes:

  • When automatic format (f_auto) is used together with automatic quality (q_auto), the PNG format may be selected when the automatic quality algorithm decides that it better fits the specific image. This allows delivering better looking and economical image files.
  • When f_auto is used together with q_auto for JPEG images and the automatic quality algorithm decides that no chroma subsampling should be performed, the JPEG format is selected instead of WebP. This behavior is needed because the lossy WebP format always performs chroma subsampling, which might result in a lower visual quality for some images.
  • Setting the any_format flag together with automatic quality (q_auto,fl_any_format) but without setting f_auto, will also allow switching to PNG8 encoding if the quality algorithm decides that it's more efficient.
  • If f_auto is used to deliver an image that contains transparency, and the requesting browser does not support WebP or JPEG-XR, then the image is delivered in PNG format instead of the JPEG format.

Adjusting image quality

Control the visual quality and compression level of JPEG, JPEG 2000, JPEG XR, WebP and GIF images with the quality parameter (q in URLs). This parameter represents the compression level to apply to an image as a value between 1 (smallest file size possible) and 100 (best visual quality). Reducing the quality is a tradeoff between visual quality and file size: the lower the quality value, the more the file is compressed to a smaller file size, the more data is lost in the process, and the result is a loss of visual quality. The loss of visual quality is barely noticeable to the human eye at the higher quality levels, and final visual quality also depends on other factors such as the size of the image and the resolution of the user's monitor or mobile screen.

For example, reducing the quality of the uploaded JPEG image named sample to 60 results in a file size of 73 KB compared to the original file size of 245 KB with a barely noticeable reduction in visual quality:

Ruby:
cl_image_tag("sample.jpg", :quality=>60)
PHP:
cl_image_tag("sample.jpg", array("quality"=>60))
Python:
CloudinaryImage("sample.jpg").image(quality=60)
Node.js:
cloudinary.image("sample.jpg", {quality: 60})
Java:
cloudinary.url().transformation(new Transformation().quality(60)).imageTag("sample.jpg")
JS:
cl.imageTag('sample.jpg', {quality: 60}).toHtml();
jQuery:
$.cloudinary.image("sample.jpg", {quality: 60})
React:
<Image publicId="sample.jpg" quality="60">
        <Transformation quality=60 />
</Image>
Angular:
<cl-image public-id="sample.jpg" quality="60">
        <cl-transformation quality=60 />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Quality(60)).BuildImageTag("sample.jpg")
Image with quality set to 60

The quality parameter is also automatically applied when delivering images with any other transformation applied. That is, unless the original uploaded image is requested, then a default quality* value of 80 is also automatically applied to the transformed image.

* The default values were updated in June 2016. Cloudinary customers that opened an account before that date will initially have the following default values for each format if the quality parameter is not specified: JPEG: 90, WebP: 75, JPEG XR and JPEG 2000: 80

The default quality setting for your Cloudinary account can be customized via the Settings page in the Management Console. We recommend setting the default value to one of the automatic quality values.

Notes:

  1. Images in the WebP format are lossless when specifying a quality of 100, and lossy when specifying a quality less than 100. See the How to support WebP images, save bandwidth and improve user experience article for more information on the WebP format.
  2. Images in the WebP format are lossless if the quality isn't specified and the original image's format is lossless (e.g., PNG).
  3. Animated GIFs ignore the quality setting unless the lossy flag is added. See the Lossy compression for optimizing animated GIFs article for more information.
  4. The JPEGmini add-on automatically applies the best compression possible to JPEG images while maintaining a high visual quality.

Automatic quality and encoding settings

Cloudinary's intelligent quality and encoding algorithm analyzes an image to find the best quality compression level and optimal encoding settings based on the image content and the viewing browser, in order to produce an image with good visual quality while minimizing the file size. Cloudinary automates the file size versus quality trade-off decision, on the fly, by using perceptual metrics and heuristics that tune the quality settings based on the specific image content and format. Analyzing every image individually to find the optimal compression level and image encoding settings allows for precise adjustment of the compression level complemented by fine tuning of the encoding settings, and can significantly reduce the file size without any degradation noticeable to the human eye.

The quality transformation parameter can be set to auto (q_auto in URLs) in order to perform automatic quality selection and image encoding adjustments. Further control of the automatic quality selection is supported as follows:

  • q_auto - The optimal balance between file size and visual quality. By default, this is the same as q_auto:good, while it can automatically switch to the more aggressive q_auto:eco mode (see the note on Save-data support below).
  • q_auto:best - Less aggressive algorithm. Generates bigger files with potentially better visual quality. Example of a target audience: photography sites that display images with a high visual quality.
  • q_auto:good - Ensuring a relatively small file size with good visual quality.
  • q_auto:eco - More aggressive algorithm, which results in smaller files of slightly lower visual quality. Example of a target audience: popular sites and social networks with a huge amount of traffic.
  • q_auto:low - Most aggressive algorithm, which results in the smallest files of low visual quality. Example of a target audience: sites using thumbnail images that link to higher quality images.

Examples of the resulting file size when encoding a photograph, using various regular and automatic quality parameter values:

Original Original (569KB) q_80 q_80 (80.3KB) q_auto:best q_auto:best (65.9KB) q_auto:good q_auto:good (56.9KB) q_auto:eco q_auto:eco (45.0KB) q_auto:low q_auto:low (35.0KB)

Ruby:
cl_image_tag("woman.jpg", :quality=>"auto")
PHP:
cl_image_tag("woman.jpg", array("quality"=>"auto"))
Python:
CloudinaryImage("woman.jpg").image(quality="auto")
Node.js:
cloudinary.image("woman.jpg", {quality: "auto"})
Java:
cloudinary.url().transformation(new Transformation().quality("auto")).imageTag("woman.jpg")
JS:
cl.imageTag('woman.jpg', {quality: "auto"}).toHtml();
jQuery:
$.cloudinary.image("woman.jpg", {quality: "auto"})
React:
<Image publicId="woman.jpg" quality="auto">
        <Transformation quality="auto" />
</Image>
Angular:
<cl-image public-id="woman.jpg" quality="auto">
        <cl-transformation quality="auto" />
</cl-image>
.Net:
cloudinary.Api.UrlImgUp.Transform(new Transformation().Quality("auto")).BuildImageTag("woman.jpg")

Examples of the resulting file size when encoding a drawing, using regular and automatic quality values:

Original Original (296KB) q_80 q_80 (223KB) q_auto:best q_auto:best (226KB) q_auto:good q_auto:good (156KB) q_auto:eco q_auto:eco (97.5KB) q_auto:low q_auto:low (87.5KB)

Ruby:
cl_image_tag("robot.jpg", :quality=>"auto")
PHP:
cl_image_tag("robot.jpg", array("quality"=>"auto"))
Python:
CloudinaryImage("robot.jpg").image(quality="auto")
Node.js:
cloudinary.image("robot.jpg", {quality: "auto"})
Java:
cloudinary.url().transformation(new Transformation().quality("auto")).imageTag("robot.jpg")
JS:
cl.imageTag('robot.jpg', {quality: "auto"}).toHtml();
jQuery:
$.cloudinary.image("robot.jpg", {quality: "auto"})
React:
<Image publicId="robot.jpg" quality="auto">
        <Transformation quality="auto" />
</Image>
Angular: