Convert, resize, or watermark images

Usage example

{
  "steps": {
    "resized": {
      "robot": "/image/resize",
      "use": ":original",
      "width": 200
    }
  }
}

Parameters

• output_meta

  Record<string, boolean> | boolean

  Allows you to specify a set of metadata that is more expensive on CPU power to calculate, and thus is disabled by default to keep your Assemblies processing fast.

  For images, you can add "has_transparency": true in this object to extract if the image contains transparent parts and "dominant_colors": true to extract an array of hexadecimal color codes from the image.

  For videos, you can add the "colorspace: true" parameter to extract the colorspace of the output video.

  For audio, you can add "mean_volume": true to get a single value representing the mean average volume of the audio file.

  You can also set this to false to skip metadata extraction and speed up transcoding.

• result

  boolean (default: false)

  Whether the results of this Step should be present in the Assembly Status JSON

• queue

  "batch"

  Setting the queue to 'batch', manually downgrades the priority of jobs for this step to avoid consuming Priority job slots for jobs that don't need zero queue waiting times

• force_accept

  boolean (default: false)
  

    Force a Robot to accept a file type it would have ignored.
  

  By default Robots ignore files they are not familiar with. 🤖/video/encode, for example, will happily ignore input images.

  With the force_accept parameter set to true you can force Robots to accept all files thrown at them. This will typically lead to errors and should only be used for debugging or combatting edge cases.

• use

  string | Array<string> | Array<object> | object

  Specifies which Step(s) to use as input.

  • You can pick any names for Steps except ":original" (reserved for user uploads handled by Transloadit)
  • You can provide several Steps as input with arrays:
    

    {
      "use": [
        ":original",
        "encoded",
        "resized"
      ]
    }
    

  Tip

  That’s likely all you need to know about use, but you can view Advanced use cases.

• format

  string | null (default: null)

  The output format for the modified image.

  Some of the most important available formats are "jpg", "png", "gif", and "tiff". For a complete lists of all formats that we can write to please check our supported image formats list.

  If null (default), then the input image's format will be used as the output format.

  If you wish to convert to "pdf", please consider 🤖/document/convert instead.

• width

  number

  Width of the result in pixels. If not specified, will default to the width of the original.

• height

  number

  Height of the new image, in pixels. If not specified, will default to the height of the input image.

• resize_strategy

  … (default: "fit")

  See the list of available resize strategies.

• zoom

  boolean (default: true)

  If this is set to false, smaller images will not be stretched to the desired width and height. For details about the impact of zooming for your preferred resize strategy, see the list of available resize strategies.

• crop

  object | string

  Specify an object containing coordinates for the top left and bottom right corners of the rectangle to be cropped from the original image(s). The coordinate system is rooted in the top left corner of the image. Values can be integers for absolute pixel values or strings for percentage based values.

  For example:

  

  {
    "x1": 80,
    "y1": 100,
    "x2": "60%",
    "y2": "80%"
  }
  

  This will crop the area from (80, 100) to (600, 800) from a 1000×1000 pixels image, which is a square whose width is 520px and height is 700px. If crop is set, the width and height parameters are ignored, and the resize_strategy is set to crop automatically.

  You can also use a JSON string of such an object with coordinates in similar fashion:

  

  "{"x1": <Integer>, "y1": <Integer>, "x2": <Integer>, "y2": <Integer>}"
  

  To crop around human faces, see 🤖/image/facedetect.

• gravity

  … (default: "center")

  The direction from which the image is to be cropped, when "resize_strategy" is set to "crop", but no crop coordinates are defined.

• strip

  boolean (default: false)

  Strips all metadata from the image. This is useful to keep thumbnails as small as possible.

• alpha

  …

  Gives control of the alpha/matte channel of an image.

• preclip_alpha

  …

  Gives control of the alpha/matte channel of an image before applying the clipping path via clip: true.

• flatten

  boolean (default: true)

  Flattens all layers onto the specified background to achieve better results from transparent formats to non-transparent formats, as explained in the ImageMagick documentation.

  To preserve animations, GIF files are not flattened when this is set to true. To flatten GIF animations, use the frame parameter.

• correct_gamma

  boolean (default: false)

  Prevents gamma errors common in many image scaling algorithms.

• quality

  string | number (default: 92)

  Controls the image compression for JPG and PNG images. Please also take a look at 🤖/image/optimize.

• adaptive_filtering

  boolean (default: false)

  Controls the image compression for PNG images. Setting to true results in smaller file size, while increasing processing time. It is encouraged to keep this option disabled.

• background

  … (default: "#FFFFFF")

  Either the hexadecimal code or name of the color used to fill the background (used for the pad resize strategy).

  Note: By default, the background of transparent images is changed to white. To preserve transparency, set "background" to "none".

• frame

  string | number | null (default: null)

  Use this parameter when dealing with animated GIF files to specify which frame of the GIF is used for the operation. Specify 1 to use the first frame, 2 to use the second, and so on. null means all frames.

• colorspace

  …

  Sets the image colorspace. For details about the available values, see the ImageMagick documentation. Please note that if you were using "RGB", we recommend using "sRGB" instead as of 2014-02-04. ImageMagick might try to find the most efficient colorspace based on the color of an image, and default to e.g. "Gray". To force colors, you might have to use this parameter in combination with type: "TrueColor".

• type

  …

  Sets the image color type. For details about the available values, see the ImageMagick documentation. If you're using colorspace, ImageMagick might try to find the most efficient based on the color of an image, and default to e.g. "Gray". To force colors, you could e.g. set this parameter to "TrueColor"

• sepia

  string | number | null (default: null)

  Applies a sepia tone effect in percent.

• rotation

  … (default: true)

  Determines whether the image should be rotated. Use integers to specify the rotation for each quarter revolution(90, 180, 270, 360). Use the value true to auto-rotate images that are rotated incorrectly or depend on EXIF rotation settings. Otherwise, use false to disable auto-fixing altogether.

• compress

  … | null (default: null)

  Specifies pixel compression for when the image is written. Compression is disabled by default.

  Please also take a look at 🤖/image/optimize.

• blur

  string | null (default: null)

  Specifies gaussian blur, using a value with the form {radius}x{sigma}. The radius value specifies the size of area the operator should look at when spreading pixels, and should typically be either "0" or at least two times the sigma value. The sigma value is an approximation of how many pixels the image is "spread"; think of it as the size of the brush used to blur the image. This number is a floating point value, enabling small values like "0.5" to be used.

• blur_regions

  Array<object> | null (default: null)

  Specifies an array of ellipse objects that should be blurred on the image. Each object has the following keys: x, y, width, height. If blur_regions has a value, then the blur parameter is used as the strength of the blur for each region.

• brightness

  string | number (default: 1)

  Increases or decreases the brightness of the image by using a multiplier. For example 1.5 would increase the brightness by 50%, and 0.75 would decrease the brightness by 25%.

• saturation

  string | number (default: 1)

  Increases or decreases the saturation of the image by using a multiplier. For example 1.5 would increase the saturation by 50%, and 0.75 would decrease the saturation by 25%.

• hue

  string | number (default: 100)

  Changes the hue by rotating the color of the image. The value 100 would produce no change whereas 0 and 200 will negate the colors in the image.

• watermark_url

  string

  A URL indicating a PNG image to be overlaid above this image. Please note that you can also supply the watermark via another Assembly Step. With watermarking you can add an image onto another image. This is usually used for logos.

• watermark_position

  … | Array<…> (default: "center")

  The position at which the watermark is placed. The available options are "center", "top", "bottom", "left", and "right". You can also combine options, such as "bottom-right".

  An array of possible values can also be specified, in which case one value will be selected at random, such as [ "center", "left", "bottom-left", "bottom-right" ].

  This setting puts the watermark in the specified corner. To use a specific pixel offset for the watermark, you will need to add the padding to the image itself.

• watermark_x_offset

  string | number (default: 0)

  The x-offset in number of pixels at which the watermark will be placed in relation to the position it has due to watermark_position.

  Values can be both positive and negative and yield different results depending on the watermark_position parameter. Positive values move the watermark closer to the image's center point, whereas negative values move the watermark further away from the image's center point.

• watermark_y_offset

  string | number (default: 0)

  The y-offset in number of pixels at which the watermark will be placed in relation to the position it has due to watermark_position.

  Values can be both positive and negative and yield different results depending on the watermark_position parameter. Positive values move the watermark closer to the image's center point, whereas negative values move the watermark further away from the image's center point.

• watermark_size

  string

  The size of the watermark, as a percentage.

  For example, a value of "50%" means that size of the watermark will be 50% of the size of image on which it is placed. The exact sizing depends on watermark_resize_strategy, too.

• watermark_resize_strategy

  … (default: "fit")

  Available values are "fit", "min_fit", "stretch" and "area".

  To explain how the resize strategies work, let's assume our target image size is 800×800 pixels and our watermark image is 400×300 pixels. Let's also assume, the watermark_size parameter is set to "25%".

  For the "fit" resize strategy, the watermark is scaled so that the longer side of the watermark takes up 25% of the corresponding image side. And the other side is scaled according to the aspect ratio of the watermark image. So with our watermark, the width is the longer side, and 25% of the image size would be 200px. Hence, the watermark would be resized to 200×150 pixels. If the watermark_size was set to "50%", it would be resized to 400×300 pixels (so just left at its original size).

  For the "min_fit" resize strategy, the watermark is scaled so that the shorter side of the watermark takes up 25% of the corresponding image side. And the other side is scaled according to the aspect ratio of the watermark image. So with our watermark, the height is the shorter side, and 25% of the image size would be 200px. Hence, the watermark would be resized to 267×200 pixels. If the watermark_size was set to "50%", it would be resized to 533×400 pixels (so larger than its original size).

  For the "stretch" resize strategy, the watermark is stretched (meaning, it is resized without keeping its aspect ratio in mind) so that both sides take up 25% of the corresponding image side. Since our image is 800×800 pixels, for a watermark size of 25% the watermark would be resized to 200×200 pixels. Its height would appear stretched, because keeping the aspect ratio in mind it would be resized to 200×150 pixels instead.

  For the "area" resize strategy, the watermark is resized (keeping its aspect ratio in check) so that it covers "xx%" of the image's surface area. The value from watermark_size is used for the percentage area size.

• text

  Array<object> (default: [])

  An array of objects each containing text rules. The following text parameters are intended to be used as properties for your array of text overlays. Here is an example:

  

  "watermarked": {
    "use": "resized",
    "robot": "/image/resize",
    "text": [
      {
        "text": "© 2018 Transloadit.com",
        "size": 12,
        "font": "Ubuntu",
        "color": "#eeeeee",
        "valign": "bottom",
        "align": "right",
        "x_offset": 16,
        "y_offset": -10
      }
    ]
  }
  

• progressive

  boolean (default: false)

  Interlaces the image if set to true, which makes the image load progressively in browsers. Instead of rendering the image from top to bottom, the browser will first show a low-res blurry version of the images which is then quickly replaced with the actual image as the data arrives. This greatly increases the user experience, but comes at a cost of a file size increase by around 10%.

• transparent

  string | string

  Make this color transparent within the image. Example: "255,255,255".

• trim_whitespace

  boolean (default: false)

  This determines if additional whitespace around the image should first be trimmed away. If you set this to true this parameter removes any edges that are exactly the same color as the corner pixels.

• clip

  string | boolean (default: false)

  Apply the clipping path to other operations in the resize job, if one is present. If set to true, it will automatically take the first clipping path. If set to a String it finds a clipping path by that name.

• negate

  boolean (default: false)

  Replace each pixel with its complementary color, effectively negating the image. Especially useful when testing clipping.

• density

  string | null (default: null)

  While in-memory quality and file format depth specifies the color resolution, the density of an image is the spatial (space) resolution of the image. That is the density (in pixels per inch) of an image and defines how far apart (or how big) the individual pixels are. It defines the size of the image in real world terms when displayed on devices or printed.

  You can set this value to a specific width or in the format widthxheight.

  If your converted image is unsharp, please try increasing density.

Demos

Related blog posts