Smart Room Composer

Fill empty rooms with your own furniture. Smart Room Composer intelligently arranges everything for a seamless and balanced design.

ENDPOINT

POST /smart_room_composer

An API URL would be like https://homedesigns.ai/api/v2/smart_room_composer

circle-info

Use the smart_room_composer endpoint to automatically arrange furniture and decor, creating a perfectly balanced and visually appealing room layout.

circle-info

An API request must be in the form-data format.

Request

Parameters & Data Type
Value
Description

room_image

file[ .jpg, .jpeg, .png] / base64 Image string

Input allows images, via file or Base64.

The image to be processed by the API. The image dimensions must be 512x512 pixels or greater for optimal results. (Required Parameter)

furniture_images[]

file[ .jpg, .jpeg, .png] / base64 Image string

Input allows a minimum of 1 and a maximum of 4 images, via file or Base64.

Choose furniture images such as a sofa, table, or chair. Add up to 4 items to create your design. The image dimensions must be 512x512 pixels or greater for optimal results. (Required Parameter)

additional_instructions

Providing instructions is optional. You can guide furniture placement within the room. This improves the final design output.

Process for Using /smart_room_composer and /smart_room_composer/status_check Endpoints

GET https://homedesigns.ai/api/v2/smart_room_composer/status_check/arrow-up-rightag61df25b20-e263-4bae-vbgbae8-ecccaafgbbd687-ugf1

  1. Step 1: Pass Required Parameters to /smart_room_composer

    • When you send a request to the /smart_room_composerendpoint with all required parameters, it will generate a queue_id.

    • Example response from /smart_room_composer:

      {
          "id": "ag61df25b20-e263-4bae-vbgbae8-ecccaafgbbd687-ugf1",
          "status": "IN_QUEUE"
      }
    • The queue_id (id value) from this response will be used in subsequent requests.


  1. Step 2: Use queue_id in /smart_room_composer/status_checkEndpoint

    • Append the generated queue_id to the /smart_room_composer/status_checkendpoint to check the processing status.

    • Example request:


  1. Step 3: Review the Status Response

    • The /smart_room_composer/status_check endpoint will return the current status of the process. Initially, the status might indicate that the process is still in "starting" wait a few moments and send the request again.

    • Example response:

    • If the status is still pending "processing", wait a few moments and send the request again.

    • Example response:

    • Once all the statuses marked as IN_QUEUE , starting and processing are completed, after hitting the requests one by one, you will see the results as follows:


  1. Step 4: Get the Final Result

    • Continue checking the status by re sending the request to the /smart_room_composer/status_check endpoint until the status changes to "SUCCESS".

    • When the status is "SUCCESS", you will receive the final result in the response.

Last updated

Was this helpful?