Search
⌃K
Comment on page

Object

Learn how to control the positioning of your product images.

Product image

AI Photoshoot API supports several options to provide source images that need to be processed.
You have to upload only images without background, so you can use Claid API Background Removal.
If you choose to upload an image with a background, the scene will be created around the entire image.

HTTP(S) URL

URL of the input image should be from 1 to 4096 characters. The image must be accessible by our system.
{
"object": {
"image_url": "https://letsenhance.io/docs/assets/samples/burger.jpg"
}
}

Connected storage

You can connect Cloud Storage and use it as a source for images. Currently, our API supports AWS S3 and Google Cloud Storage.
After connecting your Cloud Storage, you can refer the storage name as an input.
{
"object": {
"image_url": "storage://storage-name/path/image.jpg"
}
}

Input image file types

The API supports the following image formats as inputs: BMP, GIF, JPEG, PNG, TIFF, WEBP, AVIF, and HEIC.
JPEG does not support background transparency, so you will probably want to select another image format.

Rotation degree

You can do 360-degree rotation of the object by specifying the rotation_degree option.
The object will rotate in a clockwise direction from 0 to 360 degrees.
{
"object": {
"image_url": "storage://storage-name/path/image.jpg",
"rotation_degree": 90.0
}
}

Scale

You can change the size of the object in relation to the background by specifying the scale option.
By default, the object is scaled to the edges of the generated background, which is equivalent to setting scale to 1.0.
If you wish, the object can be scaled down to 10% of the total width and height of the generated background, which is equivalent to setting scale to 0.1.
{
"object": {
"image_url": "storage://storage-name/path/image.jpg",
"scale": 0.4
}
}

Position

You can move the object around the image by specifying relative object position with position option.
By default, the object is positioned at the center of the image, which corresponds to {"x":0.5, "y":0.5}.
Positioning is not an intuitive concept, so below is a reference table for positioning the object:
left top corner:
"x":0.0, "y":0.0
top edge:
"x":0.5, "y":0.0
right top corner:
"x":1.0, "y":0.0
left edge:
"x":0.0, "y":0.5
center:
"x":0.5, "y":0.5
right edge:
"x":1.0, "y":0.5
left bottom corner:
"x":0.0, "y":1.0
bottom edge:
"x":0.5, "y":1.0
right bottom corner:
"x":1.0, "y":1.0
{
"object": {
"image_url": "storage://storage-name/path/image.jpg",
"position": {
"x":0.6,
"y":0.4
}
}
}

Possible values

Parameter
Type
Range
Default value
image_url
str
1 - 4096
is required
rotation_degree
float
0.0 - 360.0
0.0
scale
float
0.0 - 1.0
1.0
position.x
float
0.0 - 1.0
0.5
position.y
float
0.0 - 1.0
0.5
AI Photoshoot API - Previous
AI Photoshoot Options
Next
Scene
Last modified 3mo ago