You do not have enough credits! Wait 24 hours for 3 new credits or UPGRADE NOW - Our Early Bird discount will expire soon. You'll never see these low prices again!

Welcome to the HomeDesignsAI API documentation.

This guide will provide you with all the information you need to interact with our API and make the most out of HomeDesignsAI's features. The API allows you to enhance, redesign, and inpaint images to create stunning designs for interiors, exteriors, and gardens. Let's get started!

API

The Base URL is the root URL under which all the API endpoints reside. API users should use this URL when making API calls.

Base URL:https://tob7trmlcmfx1q-3000.proxy.runpod.net

Select the design scope:

Select from Interiors, Exteriors, or Gardens to see all the available parameters based on the selected design scope. Upon selecting a category, you’ll see all the available design styles and room types available in each design scope.


Select this to get design styles and room types related to interior spaces like living rooms, bedrooms, etc.

Design Style
No Style Eclectic Modern
Contemporary Transitional Scandinavian
Mediterranean Ikea Industrial
Kids Room Shabby Chic Coastal
Bauhaus Bohemian Traditional
Rustic Minimalism Japandi
Japanese Design Modern Arabic Traditional Arabic
Bali Tropical Asian Decor
Zen Hollywood Regency Hollywood Glam
Minimalist Christmas Futuristic
Luxurious Midcentury Modern Biophilic
Cottage Core French Country Art Deco
Art Nouveau South Western Modern Farm House
Moroccan Gothic Victorian
Steampunk Urban Modern Desert Modernism
Colonial Brutalist Nordic Noir
Postmodern Psychedelic Cosmic Chic
Mexican Hacienda Coastal Modern Eco Friendly
Pop ArtNew Vintage GlamNew Candy LandNew
BarbieNew DoodleNew SketchNew
MaximalistNew ProfessionalNew AirBnbNew
HalloweenNew RetroNew RomanticNew
Glam RockNew SafariNew TuscanNew
NauticalNew CraftmanNew Farmhouse ChicNew
PrairieNew CubismNew
Room Type
Living room Bedroom Bathroom
Kitchen Dining room Attic
Study room Home office Family Room
Formal Dining Room Home Theater Kids Room
Balcony Gaming room Meeting room
Workshop Fitness gym Coffee shop
Clothing store Restaurant Office
Coworking space Hotel lobby Hotel room
Hotel bathroom Exhibition space Onsen
Working Space Wine Cellar Rooftop Terrace
Sunroom Home Spa Mudroom
Craft Room Dressing Room Guest Bedroom
Home Bar Library Art Studio
Yoga Studio Photo Studio Multimedia Room
Auditorium Medical Exam Room Reception Area
Music Room Science Laboratory Wedding RoomNew
Laundry RoomNew Outdoor KitchenNew Utility RoomNew
Pet RoomNew Home GymNew LoungeNew
Walk-in ClosetNew PlayroomNew Reading NookNew
SaunaNew Man CaveNew FoyerNew
GreenhouseNew She ShedNew ConservatoryNew
NurseryNew Prayer roomNew
Materials
Fabrics Glass Wood
Stone Metal Ceramics & Porcelain
Plastics & Polymers Paper & Cardboard Natural Fibers
Composite Materials - -
Colors
White Black Grey
Blue Red Green
Yellow Brown Purple
Pink Beige Navy
Sky Blue Teal Sage
Olive Emerald Sand
Soft Pink Deep Red Anthracite grey
Mustard Yellow Navy and Gold Sage Green and Beige
Black and White Terracotta and Sky Blue Lavender and Soft Pink
Emerald Green and Gray Mustard Yellow and Navy Charcoal and Dusty Rose
Mint Green and Coral Cream and Espresso Navy and Silver
Teal and Mustard Plum and Gold Olive Green and Tan
Rust and Slate Gray Powder Blue and Soft Grey Peach and Seafoam Green
Bright Yellow and Charcoal Grey Magenta and Deep Teal All-White with Black Accents
Greige and Off-White Black and Gold Burgundy and Blush Pink
Sky Blue and White Lavender and Sage Green -
Materials (Note: Materials should be selected according to the material type.)
Fabrics Glass Wood Stone Metal Ceramics & Porcelain Plastics & Polymers Paper & Cardboard Natural Fibers Composite Materials
Cotton Clear Oak Marble Steel Earthenware Acrylic Wallpaper Jute Concrete
Linen Frosted Maple Granite Aluminum Stoneware Polyethylene Cardboard Hemp Plywood
Silk Stained Cherry Bricks Brass Porcelain PVC Kraft Sisal MDF
Velvet Tempered Walnut Red Bricks Wrought Iron Terracotta Polycarbonate Parchment Coir Particleboard
Wool Laminated Pine Limestone Stainless Steel Vitreous China Polypropylene Foil embossed Bamboo fiber Fiberglass
Leather Shattered Teak Slate Chrome Bone China ABS Textured Wool Corian
Suede Patterned Mahogany Travertine Gold Glazed Epoxy Handmade paper Cotton Quartz composite
Tweed Textured Bamboo Sandstone Silver Matte Silicone Recycled paper Linen Terrazzo
Chenille Seeded Birch Quartz Copper Polished Vinyl Flocked paper Silk Engineered stone
Jacquard Colored Rosewood Onyx Bronze Textured Melamine Metallic paper Cashmere Laminate
Satin Mirrored Ash Basalt Titanium Mosaic Phenolic Vellum Mohair Vinyl composite tile
Polyester Etched Cedar Terrazzo Zinc Hand-painted Urethane Linen paper Alpaca Resin
Nylon Smoked Hickory Soapstone Nickel Crackle Fiberglass Watercolor paper Seagrass Acrylic composite
Rayon Beveled Alder Quartzite Lead Metallic Nylon Matte Ramie Carbon fiber
Cashmere Lead Crystal Ebony Dolomite Pewter Luster Acetate Glossy Abaca Glass fiber reinforced concrete
- Obscured - Gneiss - - - - - -
- - - Bluestone - - - - - -

Choose this for design styles and room types related to exterior spaces like facades, patios, etc.

Design Style
No Style Modern Mediterranean
International Moody Colors Wood Accents
Bohemian Industrial Retreat
Elegant Painted Brick Red Brick
Modern Blend Stone Clad Glass House
Ranch Modern Farm House Portuguese
Traditional Craftsman Tudor
Prairie Chalet Colonial
Dutch Colonial Revival Georgian Green
Contemporary Cottage Farmhouse
French Country Futuristic Gothic
Greek Revival Mansion Townhouse
Victorian Corporate Building
Room Type
Side of house Front of house Back of house
Materials
Facade Materials Roofing Materials Decking and Walkways
Outdoor Fixtures and Accents - -
Colors
White Black Grey
Blue Red Green
Yellow Brown Purple
Pink Beige Navy
Sky Blue Teal Sage
Olive Emerald Sand
Soft Pink Deep Red Anthracite grey
Mustard Yellow Navy and Gold Sage Green and Beige
Black and White Terracotta and Sky Blue Lavender and Soft Pink
Emerald Green and Gray Mustard Yellow and Navy Charcoal and Dusty Rose
Mint Green and Coral Cream and Espresso Navy and Silver
Teal and Mustard Plum and Gold Olive Green and Tan
Rust and Slate Gray Powder Blue and Soft Grey Peach and Seafoam Green
Bright Yellow and Charcoal Grey Magenta and Deep Teal All-White with Black Accents
Greige and Off-White Black and Gold Burgundy and Blush Pink
Sky Blue and White Lavender and Sage Green -
Materials (Note: Materials should be selected according to the material type.)
Facade Materials Roofing Materials Decking and Walkways Outdoor Fixtures and Accents
Brick Asphalt shingles Composite decking Wrought iron
Natural Stone Metal roofing Natural stone pavers Stainless steel
Granite Clay tiles Concrete pavers Copper
Fieldstone Concrete tiles Brick pavers Natural stone
Limestone Slate tiles Treated lumber Ceramic tiles
Sandstone Wooden shakes or shingles Teak -
Stucco Solar tiles Redwood decking -
Wood Roof Tiles Pea Gravel -
Vinyl - Anthracite Grey Deck -
Fiber cement - Crushed Granite -
Metal - - -
Glass - - -

Opt for this to explore design styles and room types related to gardens and outdoor spaces.

Design Style
No Style Modern Garden City Garden
Contemporary Garden Luxury Garden Apartment Garden
Small Garden Vegetable Garden Low Budget Garden
Beach Garden Wedding Garden Rural Garden
Mediterranean Garden Restaurant Garden Formal Garden
American Garden English Garden Traditional Garden
Cottage Garden Meditation Garden Coastal Garden
Tropical Garden
Room Type
Backyard Patio Terrace
Front Yard Garden Courtyard
Pool Area PorchNew PlaygroundNew
Materials
Ground Cover Materials Planters and Edging Outdoor Furniture and Decor
Water Features and Structures Lighting -
Colors
White Black Grey
Blue Red Green
Yellow Brown Purple
Pink Beige Navy
Sky Blue Teal Sage
Olive Emerald Sand
Soft Pink Deep Red Anthracite grey
Mustard Yellow Navy and Gold Sage Green and Beige
Black and White Terracotta and Sky Blue Lavender and Soft Pink
Emerald Green and Gray Mustard Yellow and Navy Charcoal and Dusty Rose
Mint Green and Coral Cream and Espresso Navy and Silver
Teal and Mustard Plum and Gold Olive Green and Tan
Rust and Slate Gray Powder Blue and Soft Grey Peach and Seafoam Green
Bright Yellow and Charcoal Grey Magenta and Deep Teal All-White with Black Accents
Greige and Off-White Black and Gold Burgundy and Blush Pink
Sky Blue and White Lavender and Sage Green -
Materials (Note: Materials should be selected according to the material type.)
Ground Cover Materials Planters and Edging Outdoor Furniture and Decor Water Features and Structures Lighting
Mulch Corten steel Teak Natural stone LED lights
Wood Chips Stone Wrought iron Fiberglass Solar-powered lights
Grass Fruit Trees Rattan Copper Low-voltage halogen
Clover Berry Bushes Fire Pits Wood Fiber optics
Moss Plants Concrete Glass -
Lawn Flowers Ceramic - -
Pebbles Concrete Brick - -
River rocks Natural Stone - - -
Ground cover plants Recycled plastic - - -
thyme Bamboo - - -
Sedum - - - -
Artificial grass - - - -
Decomposed granite - - - -

Perform Design Related operations

These are the available endpoints that API users can call to perform various design-related operations.

  • Post /beautiful_redesign ?

The beautiful_redesign endpoint applies a set of predefined design rules to enhance the aesthetics of a given space. It aims to make the space more visually appealing by optimizing various design elements.

Parameters Value Datatype Description
image - file[ .jpg, .jpeg, .png] The image to be processed by the API. The image dimensions must be 512x512 pixels or greater for optimal results.
design_type Interior, Exterior, Garden str Specifies the type of design you want to apply. This could be categories like 'Modern', 'Traditional', 'Minimalist', etc., depending on your API's capabilities.
ai_intervention Very Low, Low, Mid, Extreme str 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.
no_design Min-1,Max-4 int Specifies the number of design variations you want the API to generate. The minimum is 1 and the maximum is 4.
design_style Design style should be as per design type str Defines the overall aesthetic style you want to achieve, such as 'Bohemian', 'Industrial', 'Scandinavian', etc.
room_type Room style should be as per design type str Indicates the type of room for which the design is intended, like 'Living Room', 'Bedroom', 'Kitchen', etc.
prompt Custom Prompt null or str 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.
Parameters Error Messages Reason
image
Image field required
Invalid image size. The image width and height must be 512x512 or greater than 512x512 pixels.
Invalid image format. Only PNG, JPEG and JPG images are allowed.
Image not provided
Image Size Not Proper.
Image Format not valid.
design_type
Design_type field required
Design_type value is not a valid enumeration member; permitted: 'Interior', 'Exterior', 'Garden'
Design type not provided
design type not provided properly
room_type
room_type field required
room_type should be in ['Living room', 'Bedroom', 'Bathroom'...] this array will replaced dynamically as per your design_type
room_type not provided
room_type not provided properly
design_style
design_style field required
design_style should be in ['No Style', 'Eclectic', 'Modern'...] this array will replaced dynamically as per your design_type
Design_style not provided
Design_style not provided properly
ai_intervention
ai_intervention field required
ai_intervention value is not a valid enumeration member; permitted: 'Very Low', 'Low', 'Mid', 'Extreme'
ai_intervention not provided
ai_intervention not provided properly
no_design
no_design field required
no_design value is not a valid enumeration member; permitted: 1, 2, 3, 4
no_design not provided
no_design not provided properly
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"
    ]
}

  • Post /creative_redesign ?

The creative_redesign endpoint offers two modes: "Creative Redesign" and "Fill the Room".
The endpoint offers two modes: "Creative Redesign" and "Fill the Room". Use the 'fill' parameter to toggle between the two. If fill=true, the API will operate in "Fill the Room" mode. If fill=false, it will operate in "Creative Redesign" mode.

Parameters Value Datatype Description
image - file[ .jpg, .jpeg, .png] The image to be processed by the API. The image dimensions must be 512x512 pixels or greater for optimal results.
design_type Interior, Exterior, Garden str Specifies the type of design you want to apply. This could be categories like 'Modern', 'Traditional', 'Minimalist', etc., depending on your API's capabilities.
ai_intervention Very Low, Low, Mid, Extreme str 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.
no_design Min-1,Max-4 int Specifies the number of design variations you want the API to generate. The minimum is 1 and the maximum is 4.
design_style Design style should be as per design type str Defines the overall aesthetic style you want to achieve, such as 'Bohemian', 'Industrial', 'Scandinavian', etc.
room_type Room style should be as per design type str Indicates the type of room for which the design is intended, like 'Living Room', 'Bedroom', 'Kitchen', etc.
prompt Custom Prompt null or str 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.
fill true or false bool Setting this parameter to true activates the "Fill the Room" mode, focusing on filling up the available space with objects. Setting it to false activates the "Creative Redesign" mode, allowing for more imaginative design transformations.
Parameters Error Messages Reason
image
Image field required
Invalid image size. The image width and height must be 512x512 or greater than 512x512 pixels.
Invalid image format. Only PNG, JPEG and JPG images are allowed.
Image not provided
Image Size Not Proper.
Image Format not valid.
design_type
design_type field required
design_type value is not a valid enumeration member; permitted: 'Interior', 'Exterior', 'Garden'
design type not provided
design type not provided properly
room_type
room_type field required
room_type should be in ['Living room', 'Bedroom', 'Bathroom'...] this array will replaced dynamically as per your design_type
room_type not provided
room_type not provided properly
design_style
design_style field required
design_style should be in ['No Style', 'Eclectic', 'Modern'...] this array will replaced dynamically as per your design_type
design_style not provided
design_style not provided properly
ai_intervention
ai_intervention field required
ai_intervention value is not a valid enumeration member; permitted: 'Very Low', 'Low', 'Mid', 'Extreme'
ai_intervention not provided
ai_intervention not provided properly
no_design
no_design field required
no_design value is not a valid enumeration member; permitted: 1, 2, 3, 4
no_design not provided
no_design not provided properly
fill
fill field required
fill value could not be parsed to a boolean
fill not provided
fill not provided properly
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"
    ]
}

  • Post /inpainting ?

This 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.

Parameters Value Datatype Description
image - file[ .jpg, .jpeg, .png] The image to be processed by the API. The image dimensions must be 768x768 pixels or greater for optimal results.
masked_image - file[ .jpg, .jpeg, .png] The image to be processed by the API. The image dimensions must be 768x768 pixels or greater for optimal results.
design_type Interior, Exterior, Garden str Specifies the type of design you want to apply. This could be categories like 'Modern', 'Traditional', 'Minimalist', etc., depending on your API's capabilities.
no_design Min-1,Max-4 int Specifies the number of design variations you want the API to generate. The minimum is 1 and the maximum is 4.
design_style Design style should be as per design type str Defines the overall aesthetic style you want to achieve, such as 'Bohemian', 'Industrial', 'Scandinavian', etc.
room_type Room style should be as per design type str Indicates the type of room for which the design is intended, like 'Living Room', 'Bedroom', 'Kitchen', etc.
prompt Custom Prompt str 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.
Parameters Error Messages Reason
image
image field required
Invalid image size. The image width and height must be 768x768 or greater than 768x768 pixels.
Invalid image format. Only PNG, JPEG and JPG images are allowed.
Image not provided
Image Size must be greater than 786X786.
Image Format not valid.
masked_image
masked_image field required
Invalid image size. The image width and height must be 768x768 or greater than 768x768 pixels.
Invalid image format. Only PNG, JPEG and JPG images are allowed.
masked_image not provided
masked_image Size must be greater than 786X786.
masked_image Format not valid.
image/masked_image
Image and masked image must be same width and height.
Image and masked image has different sizes
design_type
design_type field required
design_type value is not a valid enumeration member; permitted: 'Interior', 'Exterior', 'Garden'
design type not provided
design type not provided properly
room_type
room_type field required
room_type should be in ['Living room', 'Bedroom', 'Bathroom'...] this array will replaced dynamically as per your design_type
room_type not provided
room_type not provided properly
design_style
design_style field required
design_style should be in ['No Style', 'Eclectic', 'Modern'...] this array will replaced dynamically as per your design_type
design_style not provided
design_style not provided properly
no_design
no_design field required
no_design value is not a valid enumeration member; permitted: 1, 2, 3, 4
no_design not provided
no_design not provided properly
prompt
prompt field required
prompt not provided
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"
    ]
}

  • Post /enhance ?

The enhance endpoint focuses on improving the quality of the design by adjusting various elements like lighting, contrast, and color balance. It aims to make the design more vivid and realistic.

Parameters Value Datatype Description
image - file[ .jpg, .jpeg, .png] The image to be processed by the API. The image dimensions must be 512x512 pixels or greater for optimal results.
design_type Interior, Exterior, Garden str Specifies the type of design you want to apply. This could be categories like 'Modern', 'Traditional', 'Minimalist', etc., depending on your API's capabilities.
ai_intervention Very Low, Low, Mid, Extreme str 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.
Parameters Error Messages Reason
image
image field required
Invalid image size. The image width and height must be 512x512 or greater than 512x512 pixels.
Invalid image format. Only PNG, JPEG and JPG images are allowed.
image not provided
Image Size Not Proper.
Image Format not valid.
design_type
design_type field required
design_type value is not a valid enumeration member; permitted: 'Interior', 'Exterior', 'Garden'
design type not provided
design type not provided properly
ai_intervention
ai_intervention field required
ai_intervention value is not a valid enumeration member; permitted: 'Very Low', 'Low', 'Mid', 'Extreme'
ai_intervention not provided
ai_intervention not provided properly
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"
    ]
}

  • Post /full_hd ?

The full_hd endpoint upscales the design to Full HD quality, providing a clearer and more detailed visualization. This is particularly useful for presentations or high-quality prints.

Parameters Value Datatype Description
image - file[ .jpg, .jpeg, .png] The image to be processed by the API. The image dimensions must be 512x512 pixels or greater for optimal results.
inpaited_genrated_image true or false bool Set this to true if the output result is from the "Precision +" or "Fill Spaces" section. Otherwise, set it to false.
Parameters Error Messages Reason
image
image field required
Invalid image size. The image width and height must be 512x512 or greater than 512x512 pixels.
Invalid image format. Only PNG, JPEG and JPG images are allowed.
image not provided
Image Size Not Proper.
Image Format not valid.
inpaited_genrated_image
inpaited_genrated_image field required
inpaited_genrated_image value could not be parsed to a boolean
inpaited_genrated_image not provided
inpaited_genrated_image not provided properly
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"
    ]
}

  • Post /decor_staging ?

This endpoint enables the staging of furniture or decorative objects into various real-life scenarios, applicable to both interiors and exteriors. Upon uploading an object, the AI processes and stages it in realistic settings. This endpoint is particularly useful for furniture manufacturers and e-commerce stores, providing a tool to visualize products in different environments.

Parameters Value Datatype Description
image - file[ .jpg, .jpeg, .png] The image width and height must be 768x768 or greater than 768x768 pixels.
masked_image - file[ ‘.jpg’, ’.jpeg’, ’.png’ ] The image width and height must be 768x768 or greater than 768x768 pixels.
design_type Interior, Exterior, Garden str Specifies the type of design you want to apply. This could be categories like 'Modern', 'Traditional', 'Minimalist', etc., depending on your API's capabilities.
no_design Min-1,Max-4 int Specifies the number of design variations you want the API to generate. The minimum is 1 and the maximum is 4.
design_style Design style should be as per design type str Defines the overall aesthetic style you want to achieve, such as 'Bohemian', 'Industrial', 'Scandinavian', etc.
room_type Room style should be as per design type str Indicates the type of room for which the design is intended, like 'Living Room', 'Bedroom', 'Kitchen', etc.
prompt Custom Prompt str 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.
transparent bool null or str While uploading a transparent image, it is incapable to mask image. In such cases, the 'is_transparent' flag will be set to true. On the other hand, if the image provided is not transparent, it will be allowed to proceed, and the 'is_transparent' flag will be set to false.
Parameters Error Messages Reason
image
image field required
Invalid image size. The image width and height must be 768x768 or greater than 768x768 pixels.
Invalid image format. Only PNG, JPEG and JPG images are allowed.
Image not provided
Image Size must be greater than 786X786.
Image Format not valid.
masked_image
masked_image field required
Invalid image size. The image width and height must be 768x768 or greater than 768x768 pixels.
Invalid image format. Only PNG, JPEG and JPG images are allowed.
masked_image not provided
masked_image Size must be greater than 786X786.
masked_image Format not valid.
design_type
design_type field required
design_type value is not a valid enumeration member; permitted: 'Interior', 'Exterior', 'Garden'
design type not provided
design type not provided properly
room_type
room_type field required
room_type should be in ['Living room', 'Bedroom', 'Bathroom'...] this array will replaced dynamically as per your design_type
room_type not provided
room_type not provided properly
design_style
design_style field required
design_style should be in ['No Style', 'Eclectic', 'Modern'...] this array will replaced dynamically as per your design_type
design_style not provided
design_style not provided properly
no_design
no_design field required
no_design value is not a valid enumeration member; permitted: 1, 2, 3, 4
no_design not provided
no_design not provided properly
prompt
prompt field required
prompt not provided
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"
    ]
}

  • Post /furniture_removal ?

This endpoint utilizes AI to declutter interior or exterior spaces. It offers the functionality to remove all furniture from a room, rendering it completely empty. Additionally, this endpoint supports selective removal of furniture, allowing users to specify and remove particular items from a space. This feature is ideal for creating clean and uncluttered visualizations of rooms or outdoor areas.

Parameters Value Datatype Description
image - file[ .jpg, .jpeg, .png] The image width and height must be 768x768 or greater than 768x768 pixels.
masked_image - file[ ‘.jpg’, ’.jpeg’, ’.png’ ] The image width and height must be 768x768 or greater than 768x768 pixels.
no_design Min-1,Max-4 int Specifies the number of design variations you want the API to generate. The minimum is 1 and the maximum is 4.
Parameters Error Messages Reason
image
image field required
Invalid image size. The image width and height must be 768x768 or greater than 768x768 pixels.
Invalid image format. Only PNG, JPEG and JPG images are allowed.
Image not provided
Image Size must be greater than 786X786.
Image Format not valid.
masked_image
masked_image field required
Invalid image size. The image width and height must be 768x768 or greater than 768x768 pixels.
Invalid image format. Only PNG, JPEG and JPG images are allowed.
masked_image not provided
masked_image Size must be greater than 786X786.
masked_image Format not valid.
no_design
no_design field required
no_design value is not a valid enumeration member; permitted: 1, 2, 3, 4
no_design not provided
no_design not provided properly
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"
    ]
}

Demo

<!DOCTYPE html>
<html>
<head>
 <title>Image Upload</title>
</head>
<body>
 <form id="imageForm">
  <input type="file" id="imageInput" accept="image/*" />
  <button type="button" id="uploadButton">Upload Image</button>
 </form>
 <div id="response"></div>
<script>
 document.addEventListener("DOMContentLoaded", function () {
  const imageInput = document.getElementById("imageInput");
  const uploadButton = document.getElementById("uploadButton");
  const responseDiv = document.getElementById("response");
  const jwtToken = "Your Token";
  uploadButton.addEventListener("click", function () {
   const file = imageInput.files[0];
   if (file) {
    const formData = new FormData();
    formData.append("image", file);
    formData.append('design_type', 'Interior');
    formData.append('room_type', 'Living room');
    formData.append('design_style', 'No Style');
    formData.append('ai_intervention', 'Mid');
    formData.append('no_design', 1);
    formData.append('fill', true);
    const headers = new Headers({
     Authorization: "Bearer " + jwtToken,
    });
    fetch("https://tob7trmlcmfx1q-3000.proxy.runpod.net/creative_redesign", {
     method: "POST",
     body: formData,
     headers: headers,
    })
    .then(response => response.json())
    .then(data => {
     responseDiv.textContent = JSON.stringify(data);
    })
    .catch(error => {
     responseDiv.textContent = "An error occurred: " + error.message;
    });
   } else {
    responseDiv.textContent = "Please select an image.";
   }
  });
 });
</script>
</body>
</html>

Do not refresh page. We are processing your order.