Fill Spaces

This fill spaces endpoint is designed for filling in missing objects or replacing parts of a design. It requires two images: the actual image and a masked image. You'll need to create functionality for masking the image to indicate the areas that need inpainting.

ENDPOINT

POST /fill_spaces

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

Use this to automatically fill in the missing or damaged part of the design.

Request

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 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. Click Here to generate a mask image Video Tutorial. (Required Parameter)
design_type string	Interior, Exterior, Garden	Specifies the type of area you want to design. API users must specify whether they are designing an interior space, an exterior area, or a garden. (Required Parameter)
no_design integer	Min - 1, Max - 4	Specifies the number of design variations you want the API to generate. The minimum is 1 and the maximum is 4. (Required Parameter)
design_style string	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) Here you can see the more design styles. Interior Design Styles Exterior Design Styles Garden Design Styles
room_type string	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. Click here to see more room types.
house_angle string	House angle should be as per design type	Required if design_type is Exterior, Indicates the angle of house for which the design is intended, like 'Side of house, 'Front of house', 'Back of house'. Click here to see more house angles.
garden_type string	Garden type should be as per design type	Required if design_type is Garden, Indicates the type of garden for which the design is intended, like 'Backyard', 'Front Yard', 'Courtyard', etc. Click here to see more garden types.
prompt null or string	Write a Custom Prompt	An optional text prompt that can guide the AI in generating the design. This could be something like "Create a cozy and warm living room".
strength integer		The strength field must be between 1 and 10.

Errors

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 786X786.
Invalid image format. Only PNG, JPEG and JPG images are allowed.	masked_image Format not valid.

design_type

Error Messages	Reason
Design_type field required	Design type not provided
Design_type value is not a valid enumeration member; permitted: 'Interior', 'Exterior', 'Garden'	design type 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

house_angle

Error Messages	Reason
house_angle field required when design_type is Exterior	house_angle not provided
house_angle should be in ['Side of House', 'Front of House', 'Back of House'...] this array will replaced dynamically as per your design_type	house_angle not provided properly

garden_type

Error Messages	Reason
garden_type field required when design_type is Garden	garden_type not provided
garden_type should be in ['Backyard', 'Patio', 'Terrace'...] this array will replaced dynamically as per your design_type	garden_type not provided properly

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

no_design

Error Messages	Reason
no_design field required	no_design not provided
no_design value is not a valid enumeration member; permitted: 1, 2, 3, 4	no_design not provided properly

prompt

Error Messages	Reason
prompt field required	prompt not provided

strength

Error Messages	Reason
If you selected strength field then required	The strength field must be between 1 and 10.

Response

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

{
    "input_image": "https://storage.googleapis.com/generativebucketapi/UserGenerations/cristian/input-20230901-085649876484.png",
    "output_images": [
            "https://storage.googleapis.com/generativebucketapi/UserGenerations/cristian/20230901-085649876484-1.png",
            "https://storage.googleapis.com/generativebucketapi/UserGenerations/cristian/20230901-085649876484-2.png",
            "https://storage.googleapis.com/generativebucketapi/UserGenerations/cristian/20230901-085649876484-3.png"
    ]
}

What is Masked Image?