Resizing
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
Width and Height
Specifies the size of the output image. The width
and height
parameter supports dynamic sizing and is based on pixels or percent values.
The default behavior of API resizing
If
width
andheight
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
orheight
), 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
orheight
), another side will be defined as auto and the final image will be resized keeping the aspect ratio.When
width
andheight
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 |
---|---|---|
"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 |
1000 | integer |
|
"200%" | string | Percentage as a string. E.g. "200%" means that the dimension will double relative to the input image. |
Examples
You can read more about "fit": "bounds"
, which is used in the following examples in Fit section
JSON Body
Fit
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.
Generative Resize
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.
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:
Value | Type | Description |
---|---|---|
crop | string or object | DEFAULT.
Scales an image until it fully covers the specified |
bounds | string | Scales an image until the larger side reaches the edge of canvas established by |
cover | string | Scales an image until the smaller side reaches the edge of canvas established by |
canvas | string | 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 | Scales an image until the larger side reaches the edge of canvas established by |
Examples
JSON Body
Smart Crop
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 an 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.
Last updated