Resizing
Last updated
Last updated
The Claid API allows you to set the final image size for different workflows you may have. By default, API will perform all calculations respecting the original image aspect ratio. Meaning, the image can be cropped but it won't be stretched or squeezed.
When you need a size bigger than the original image, you can use upscale parameter to increase the final image resolution
Specifies the size of the output image. The width and height parameter supports dynamic sizing and is based on pixels or percent values.
If width and height are not specified the image size will not be changed.
If you use default fit option(crop) and specify only one side of the image(width or height), the unspecified side remains unchanged and you get a cropped image.
If you use a fit option other than the default crop and specify only one side of the image(width or height), another side will be defined as auto and the final image will be resized keeping the aspect ratio.
When width and height are specified the resulting image will be resized until it fully covers the specified dimensions and gets cropped.
The default behavior can be changed by the fit property.
Acceptable values:
| Value | Type | Description |
|---|---|---|
You can read more about "fit": "bounds", which is used in the following examples in Fit section
JSON Body
The fit parameter controls how the image will be constrained within the provided size, relative to the width and height. Check the image examples below to see how fit works.
Possible properties:
bounds Preserves the aspect ratio. Resize the image to fit entirely within the specified region, making one dimension smaller if needed.
cover Preserving aspect ratio. Resize the image to entirely cover the specified region, making one dimension larger if needed.
canvas Input image will be placed on the canvas established by width and height. The aspect ratio of the input image won’t change. Extra space will be filled with the background color.
crop Scales an image until it fully covers the specified dimensions, the rest gets cropped. Fit crop support center and smart modes for cropping. See the Smart Crop section of this page to learn more.
outpaint Generates a coherent background for an image to fit specified dimensions, scaling an image until the larger side reaches the edge of canvas established by width and height first, so generation happens on either left-right or top-bottom sides symmetrically.
The feathering parameter of the outpaint object allows you to adjust the smoothness of the transition from the original image content to the generated area. The feathering value is the ratio of the transition area to the total width or height of the input image, depending on what is being resized. In most cases there will be two generated areas on the output image, so "50%" is a limit as it will turn the entire input image into a transition area.
outpaint fit type currently has size limitations: the target image size must not exceed 4.19 MP (e.g., 2048 x 2048 pixels, 2350 x 1743 pixels). Our team is working on increasing max size
Possible values:
JSON Body
Fit crop supports center and smart modes for cropping.
center is a basic cropping mode that crops images from their center without considering their content.
smart is a content-aware cropping mode that detects a main object in a photo and uses it as the center point for cropping.
Smart Crop ensures output photos are perfectly framed and focused on the main object.
| Value | Type | Description |
|---|---|---|
"auto"
string
The dimension will be calculated automatically to save the aspect ratio of the input image. Both width and height cannot be set to auto. When using auto, specify at least one of the dimensions in pixels or percentages.
1000
integer
width or height in pixels.
"200%"
string
Percentage as a string. E.g. "200%" means that the dimension will double relative to the input image.
crop
string or object
DEFAULT.
Scales an image until it fully covers the specified width and height, the rest gets cropped. Content-aware cropping.
bounds
string or object
Scales an image until the larger side reaches the edge of canvas established by width and height.
cover
string or object
Scales an image until the smaller side reaches the edge of canvas established by width and height.
canvas
string or object
Puts input image on the canvas established by width and height. Aspect ratio and size of the input image won't change. Extra space will be filled with the specified background color.
outpaint
string or object
Scales an image until the larger side reaches the edge of canvas established by width and height, then fills the extra space with a generated coherent background.
crop: center compared to crop: smart
