Targeted Element API
The Targeted Element service allows you to transform a specific element in an image while preserving the rest of the composition.Modify an element
This endpoint initiates a new generation to modify a specific element in your image. This operation also creates a new project.Request Parameters
string
required
The unique user identifier (UUID) that you can retrieve from your Developer Space
string
required
URL of the image containing the element to modify (format: jpg, png)
string
required
Type of element to modify. Possible values: “WALL”, “FLOOR”, “CEILING”, “FURNITURE”, etc.
string
The URL we call once the generation is complete
Response
string
The unique generation identifier (UUID) to use with the retrieval API
number
The number of photos remaining after this generation
string
The unique project identifier (UUID)
Request Example
Response Example
Generate a variation of a modification
This endpoint allows you to generate a variation of a previously performed element modification.Request Parameters
string
required
The unique user identifier (UUID)
string
required
The unique identifier of the previous generation
string
required
Type of element to modify for this variation. Possible values: “WALL”, “FLOOR”, “CEILING”, “FURNITURE”, etc.
Response
string
The unique identifier of the new generation
Request Example
Response Example
Retrieve a generated modification
This endpoint allows you to obtain the result of a previously performed generation.Request Parameters
string
required
The unique user identifier (UUID)
string
required
The unique identifier of the generation to retrieve
Response
string
The generation status: “STARTING”, “PROCESSING”, “SUCCEEDED”, “FAILED”
array
An array containing the URLs of generated images (present only if status=“SUCCEEDED”)
number
The number of variations already performed on this project