API Documentation
  • Introduction
  • API Reference
  • 🔐Authentication
  • Core APIs
    • Perfect Redesign
    • Beautiful Redesign
    • Creative Redesign
    • Sketch to Render
    • Virtual staging
    • Precision
    • Fill Spaces
    • Decor Staging
    • Furniture Removal
    • Colors & Textures
    • Furniture Finder
    • Full HD
    • Text to design
    • Furniture Creator
    • Design Advisor
    • Sky Colors
    • Design Transfer
    • Floor Editor
    • Paint Visualizer
    • Material Swap
    • Room Composer
    • Design Critique
    • Create Mask Image
    • Download Generated Images
    • Smart Home AI
  • DESIGN SCOPE
    • Interiors
      • Design Styles for Interiors
      • Room Types
      • Colors in Interior Design
      • Explore Material Options for Interior Designs
    • Exteriors
      • Design Styles for Exteriors
      • Copy of Design Styles for Exteriors
      • House angles
      • Exterior Colors
      • Material Options for Exterior Designs
    • Gardens
      • Design Styles for Gardens
      • Garden Types
      • Explore Color Options for Garden Designs
      • Material Options for Garden Designs
  • Data
    • User Details
    • Design Scope
  • Others
    • What is Masked Image?
Powered by GitBook
On this page

Was this helpful?

  1. Core APIs

Room Composer

PreviousMaterial SwapNextDesign Critique

Last updated 4 months ago

Was this helpful?

Arrange and visualize different decor items within a room. The room_composer endpoint places multiple pieces of furniture and decor into a space, ensuring a cohesive, harmonious design setup.

ENDPOINT

POST /room_composer

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

Room Composer is a feature within HomeDesignsAI that allows you to create and design interior spaces within a room.

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

Request

Parameters & Data Type
Value
Description

image

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

-

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

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

-

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

design_style

Design style should be as per design type

Defines the overall aesthetic style you want to achieve, such as 'Bohemian', 'Industrial', 'Scandinavian', etc. (Required Parameter)

room_type

Room style should be as per design type

Required if design_type is Interior, Indicates the type of room for which the design is intended, like 'Living Room', 'Bedroom', 'Kitchen', etc (Required Parameter)

ai_intervention

Mid, Extreme

indicates the level of AI intervention in the design process. "Mid" means minimal changes, while "Extreme" allows for significant alterations to the original design. (Required Parameter)

Parameters & Errors

image

Error Messages
Reason

Image field required

Image not provided

Invalid image size. The image width and height must be 512x512 or greater than 512x512 pixels.

Image Size Not Proper.

Invalid image format. Only PNG, JPEG and JPG images are allowed.

Image Format not valid.

masked_image

Error Messages
Reason

masked_image field required

masked_image not provided

Invalid image size. The image width and height must be 512x512 or greater than 512x512 pixels.

masked_image Size must be greater than 512x512.

Invalid image format. Only PNG, JPEG and JPG images are allowed.

masked_image Format not valid.

design_style

Error Messages
Reason

design_style field required

Design_style not provided

design_style should be in ['No Style', 'Eclectic', 'Modern'...] this array will replaced dynamically as per your design_type

Design_style not provided properly

room_type

Error Messages
Reason

room_type field required when design_type is Interior

room_type not provided

room_type should be in ['Living room', 'Bedroom', 'Bathroom'...] this array will replaced dynamically as per your design_type

room_type not provided properly

ai_intervention

Error Messages
Reason

ai_intervention field required

ai_intervention not provided

ai_intervention value is not a valid enumeration member; permitted: 'Mid', 'Extreme'

ai_intervention not provided properly


//Output should be in list of array depends on no of designs as shown below:

{
    "input_image": "https://storage.googleapis.com/generativeartbucket/UserGenerations/cristian/input-9a87be38-4cbf-4a6f-9e8c-434c0a8f73ef-2024-05-30-11-08-30.png",
    "output_images": [
            "https://storage.googleapis.com/generativeartbucket/UserGenerations/cristian/output-9a87be38-4cbf-4a6f-9e8c-434c0a8f73ef-1.png",
            "https://storage.googleapis.com/generativeartbucket/UserGenerations/cristian/output-9a87be38-4cbf-4a6f-9e8c-434c0a8f73ef-2.png",
            "https://storage.googleapis.com/generativeartbucket/UserGenerations/cristian/output-9a87be38-4cbf-4a6f-9e8c-434c0a8f73ef-2.png"
    ]
}


Click Here
Video Tutorial.
Page cover image