Product Photo

API documentation and implementation examples for the Product Photo model.

Part of the Image To Image / Product collection

API Endpoint

/v1/image-to-image/product

Request Parameters

prompt(Required)string

Text prompt to guide the image processing

image_url(Required)string

URL of the product image to be processed

padding_valuesobject

Custom padding values for manual padding placement

topinteger

Top padding in pixels

leftinteger

Left padding in pixels

rightinteger

Right padding in pixels

bottominteger

Bottom padding in pixels

placement_typestring

Method for determining how the product is placed on the background

background_image_urlstring

Optional URL for a custom background image

manual_placement_selectionstring

Specific position to place the product when using manual placement

Code Examples

Response Example

Response Fields

seed(Required)integer

Seed value used for the generation

images(Required)array [object]

Array of generated images

Array items:

[item]object

urlstring

URL of the generated image

widthinteger

Width of the image in pixels

heightinteger

Height of the image in pixels

file_datastring

Base64-encoded image data (if applicable)

file_namestring

Name of the image file

file_sizeinteger

Size of the image file in bytes

content_typestring

Content type/MIME type of the image

prompt(Required)string

The prompt used to generate the images

has_nsfw_concepts(Required)array [boolean]

Array indicating whether each image contains NSFW concepts