Room Creation API
API documentation for the room creation service
Room Creation API
The Room Creation service allows you to generate realistic interior visualizations from a designated area in an image.
Generate a room creation
This endpoint initiates a new generation to create a room in an area specified by a mask. This operation also creates a new project.
Request Parameters
The unique user identifier (UUID) that you can retrieve from your Developer Space
URL of the base image for creation (format: jpg, png)
URL of the mask indicating the area where the room should be generated
Type of room to generate. Possible values: “BATHROOM”, “KITCHEN”, “SHOWEROOM”
Design theme for the room. Possible values: “MODERN”, “INDUSTRIAL”, “SCANDINAVIAN”, “LUXURIOUS”
Width of the image in pixels
Height of the image in pixels
The URL we call once the generation is complete
Response
The unique generation identifier (UUID) to use with the retrieval API
The number of photos remaining after this generation
The unique project identifier (UUID)
Request Example
Response Example
Generate a room variation
This endpoint allows you to generate a variation of a previously created room.
Request Parameters
The unique user identifier (UUID)
The unique identifier of the previous generation
URL of the original image used for the previous generation
Optional URL of a new mask. If not provided, the mask from the previous generation will be used
Room type for this variation. Possible values: “BATHROOM”, “KITCHEN”, “SHOWEROOM”
Design theme for this variation. Possible values: “MODERN”, “INDUSTRIAL”, “SCANDINAVIAN”, “LUXURIOUS”
The URL we call once the generation is complete
Response
The unique identifier of the new generation
Request Example
Response Example
Retrieve a room creation
This endpoint allows you to obtain the result of a previously performed generation.
Request Parameters
The unique user identifier (UUID)
The unique identifier of the generation to retrieve
Response
The generation status: “STARTING”, “PROCESSING”, “SUCCEEDED”, “FAILED”
An array containing the URLs of generated images (present only if status=“SUCCEEDED”)
The number of variations already performed on this project
Request Example
Response Example
Important note: In case of “FAILED” status, your photos are automatically refunded.