Material Swap
This could involve changing the type of material used for a particular element, such as switching from wood to metal for a furniture piece or from traditional tiles to marble for a flooring surface.
ENDPOINT
POST /material_swap
An API URL would be like https://homedesigns.ai/api/v2/material_swap
Replace materials on surfaces to explore different textures and finishes.
An API request must be in the form-data format.
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)
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)
no_design
integer
Min - 2, Max - 5
Specifies the number of design variations you want the API to generate. The minimum is 2 and the maximum is 5. (Required Parameter)
texture_image
file[ .jpg, .jpeg, .png] / base64 Image string
The texture image should be uploaded according to your preference.
The image to be processed by the API.
(Required Parameter)
no_of_texture
The number of textures must be either The number of textures must be either 1 X 1, 2 X 2, 3 X 3, 4 X 4, 5 X 5.
The number of textures can be changed according to your preference. (Required Parameter)
prompt null or string
Custom Prompt
An optional parameter that allows users to provide a descriptive guide for the AI, This could involve changing the material of a specific element, such as replacing wood with metal for a furniture piece or switching traditional tiles to marble flooring. Users can also upload a texture or reference image along with a descriptive prompt. The AI will analyze both the texture image and the user's instructions to understand the desired material, finish, pattern, and overall design changes, then generate a new image that accurately reflects the requested modifications while maintaining a realistic and cohesive appearance.
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.
masked_image
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.
no_design
no_design field required
no_design not provided
no_design value is not a valid enumeration member; permitted: 2, 3, 4, 5.
no_design not provided properly
texture_image
The texture_image field is required.
whether the texture_image is required to get the results.
The texture_image field must be a file of type: jpeg, png, jpg
Image Format is not valid.
no_of_texture
no_of_texture field required
no_of_texture not provided
no_of_texture value is not a valid enumeration member; permitted: 1 X 1, 2 X 2, 3 X 3, 4 X 4, 5 X 5.
no_of_texture not provided properly
Last updated
Was this helpful?