
Perfect Redesign
Transform your home spaces with stunning furniture and interiors tailored to your needs. This feature enhances your living environment while preserving essential structural elements. Achieve a harmonious blend of style and functionality. A seamless solution for a beautifully redesigned home!
ENDPOINT
POST /perfect_redesign
An API URL would be like https://homedesigns.ai/api/v2/perfect_redesign
Request
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)
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. (Required Parameter)
ai_intervention
string
Very Low, Low, Mid, Extreme
Indicates the level of AI intervention in the design process. "Very Low" means minimal changes, while "Extreme" allows for significant alterations to the original design. (Required Parameter)
no_design
integer
Min - 1, Max - 2
Specifies the number of design variations you want the API to generate. The minimum is 1 and the maximum is 2. (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.
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.
custom_instruction
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".
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 equired 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.
keep_structural_element
boolean
Should be Either True or False
Not required, It will take the value as true by default.
Parameters & Errors
image
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.
design_type
Design_type field required
Design type not provided
Design_type value is not a valid enumeration member; permitted: 'Interior.'
design type not provided properly
room_type
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
design_style
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
ai_intervention
ai_intervention field required
ai_intervention not provided
ai_intervention value is not a valid enumeration member; permitted: 'Very Low', 'Low', 'Mid', 'Extreme'
ai_intervention not provided properly
no_design
no_design field required
no_design not provided
no_design value is not a valid enumeration member; permitted: 1, 2.
no_design not provided properly
house_angle
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
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
status_check
Please Enter a Valid Queue ID
Invalid queue ID or (queue_id is valid for the 30 minutes if you try after then showing error)
//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"
]
}Process for Using /perfect_redesign and /status_check Endpoints
/perfect_redesign and /status_check EndpointsGET https://homedesigns.ai/api/v2/perfect_redesign/status_check/ag61df25b20-e263-4bae-vbgbae8-ecccaafgbbd687-ugf1
Step 1: Pass Required Parameters to
/perfect_redesignWhen you send a request to the
/perfect_redesignendpoint with all required parameters, it will generate aqueue_id.Example response from
/perfect_redesign:{ "id": "ag61df25b20-e263-4bae-vbgbae8-ecccaafgbbd687-ugf1", "status": "IN_QUEUE" }The
queue_id(idvalue) from this response will be used in subsequent requests.queue_idis valid for the 30 minutes if you try after then showing error {Please Enter a Valid Queue ID}
Step 2: Use
queue_idin/perfect_redesign/status_checkEndpointAppend the generated
queue_idto the/perfect_redesign/statusendpoint to check the processing status.Example request:
GET /perfect_redesign/status_check/ag61df25b20-e263-4bae-vbgbae8-ecccaafgbbd687-ugf1
Step 3: Review the Status Response
The
/perfect_redesign/status_checkendpoint 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:
{ "created_at": "2025-05-26T12:39:19.094Z", "status": "starting" }If the status is still pending
"Processing"wait a few moments and send the request again.Example response:
{ "created_at": "2025-05-26T12:37:35.003Z", "started_at": "2025-05-26T12:37:35.011161515Z", "status": "processing" }Once all the statuses marked as
IN_QUEUE,startingandprocessingare completed, after hitting the requests one by one, you will see the results as follows://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" ] }
Step 4: Get the Final Result
Continue checking the status by resending the request to the
/perfect_redesign/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?