Page cover
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Magic redesign

Magic Redesign lets you re imagine any space in seconds. Just upload a photo and describe what you'd like to change. You can also provide up to 3 optional reference images to guide the AI with specific furniture styles, décor preferences, color palettes, layouts, or design inspirations.

Our conversational AI will transform furniture, layouts, colors, materials, and more based on your instructions and reference images, helping generate more accurate and personalized design results.

ENDPOINT

POST /magic_redesign

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

Use this endpoint to transform your space effortlessly by describing your requirements. Our Magic Redesign API uses conversational AI to instantly generate redesigned visuals based on your input.

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)

design_action

string

The design_action should be in [Redesign, Virtual Staging, Remodel, Renovate, Remove Furniture, Paint Walls, Landscaping, Exterior Design, Others].

Magic Redesign uses advanced AI to generate stunning designs based on your instructions.(Required Parameter)

custom_instruction string

-

This field allows users to describe what kind of image they want to generate. The AI will process the prompt and generate an image accordingly.(Required Parameter)

optimizePrompt string

Should be Either True or False

Not required, It will take the value as true by default.

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

Optional

Upload up to 3 reference images to guide the AI with furniture, décor, colors, materials, layouts, or design inspirations. These images help generate more accurate and personalized design results. (Optional 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.

design_action

Error Messages
Reason

design_action field required

design_action not provided

design_action value is not a valid enumeration member; permitted: 'Renovate'

design_action not provided properly The design_action should be in [Redesign, Virtual Staging, Remodel, Renovate, Remove Furniture, Paint Walls, Landscaping, Exterior Design, Others]

status_check

Error Messages
Reason

Please Enter a Valid Queue ID

Invalid queue ID.

reference_images[]

Error Message
Reason

The reference_images field must be an array.

Invalid request format.

You can upload maximum 3 reference images.

More than 3 reference images provided.

Invalid reference image. Please provide a valid image.

Invalid image file.

Reference image minimum dimensions should be [512 x 512].

Image resolution too small.

Invalid base64 reference image.

Invalid base64 image provided.

Process for Using /magic_redesign and /magic_redesign/status_check Endpoints

GET https://homedesigns.ai/api/v2/magic_redesign/status_check/k6rgnd3yh1rmt0cx8c4txnz6fg

  1. Step 1: Pass Required Parameters to /magic_redesign

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

    • Example response from /magic_redesign:

    • The queue_id (id value) from this response will be used in subsequent requests.


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

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

    • Example request:


  1. Step 3: Review the Status Response

    • The /magic_redesign/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 /magic_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