Create Mask Image

Generate a mask image to isolate specific objects in a photo. The create_maskimage endpoint allows for a precise selection of areas or items to edit or remove, essential for detailed design work.

ENDPOINT

POST /create_maskimage

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

Creating a mask image involves creating an image with black and white areas that correspond to the areas you want to be transparent or opaque in the target image.

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.
labels string	Select labels based on the options available in the image.	Select a segment of the uploaded image to use as a label such as Sofa, Rug, floor, Wall, etc.

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.

labels

Error Messages	Reason
Labels are required.	Please select the required parameters.
Please enter valid labels

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"

    ]
}