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://homedesigns.ai/api/v2

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
AirbnbNew Glam RockNew BarbieNew
DoodleNew SketchNew MaximalistNew
ProfessionalNew HalloweenNew RetroNew
RomanticNew SafariNew TuscanNew
NauticalNew CraftmanNew Farmhouse ChicNew
PrairieNew CubismNew Quiet LuxuryNew
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 Closet PlayroomNew Reading NookNew
SaunaNew Man CaveNew FoyerNew
GreenhouseNew She ShedNew ConservatoryNew
NurseryNew Prayer Room Open Kitchen Living Room
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 Georgian Green
Contemporary Christmas Cottage
Farmhouse French Country Futuristic
Gothic Greek Revival Mansion
Townhouse Victorian Corporate Building
House Engle
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 City
Contemporary Luxury Apartment
Small Vegetable Low Budget
Beach Wedding Rural
Mediterranean Restaurant Formal
American English Traditional
Cottage Meditation Coastal
Tropical Christmas
Garden 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] / base64 Image String 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 Required if design_type is Interior, Indicates the type of room for which the design is intended, like 'Living Room', 'Bedroom', 'Kitchen', etc.
house_angle House angle should be as per design type str 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'
garden_type Garden type should be as per design type str Required if design_type is Garden, Indicates the type of garden for which the design is intended, like 'Backyard', 'Front Yard', 'Courtyard', 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 when design_type is Interior
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
house_angle
house_angle field required when design_type is Exterior
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
house_angle not provided properly
garden_type
garden_type field required when design_type is Garden
garden_type should be in ['Backyard', 'Patio', 'Terrace'...] this array will replaced dynamically as per your design_type
garden_type not provided
garden_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 unleashes the full creative power of AI to transform architectural and interior spaces. Unlike the beautiful_redesign endpoint, which focuses on beautifying existing spaces with minimal structural changes, creative_redesign allows for more radical transformations and imaginative reinventions. This endpoint is designed to elevate the original design concepts by applying a higher degree of artistic freedom and innovation. It enables architects, designers, and real estate professionals to explore avant-garde ideas and see beyond conventional designs. Whether you are aiming to propose visionary remodels, showcase futuristic real estate possibilities, or generate unique marketing materials, the creative_redesign endpoint offers a platform where creativity knows no bounds.

Parameters Value Datatype 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.
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 Required if design_type is Interior, Indicates the type of room for which the design is intended, like 'Living Room', 'Bedroom', 'Kitchen', etc.
house_angle House angle should be as per design type str 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'
garden_type Garden type should be as per design type str Required if design_type is Garden, Indicates the type of garden for which the design is intended, like 'Backyard', 'Front Yard', 'Courtyard', 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 when design_type is Interior
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
house_angle
house_angle field required when design_type is Exterior
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
house_angle not provided properly
garden_type
garden_type field required when design_type is Garden
garden_type should be in ['Backyard', 'Patio', 'Terrace'...] this array will replaced dynamically as per your design_type
garden_type not provided
garden_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 /sketch_to_render ? New

The sketch_to_render endpoint transforms rough sketches or drawings of house interiors or exteriors into detailed, hyper-realistic renders. This tool is indispensable for architects, designers, and homebuilders, facilitating a clearer vision of upcoming projects and proposals. By providing a detailed visualization from simple sketches, this endpoint helps bridge the gap between concept and reality, enhancing client presentations and design accuracy.

Parameters Value Datatype 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.
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 Required if design_type is Interior, Indicates the type of room for which the design is intended, like 'Living Room', 'Bedroom', 'Kitchen', etc.
house_angle House angle should be as per design type str 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'
garden_type Garden type should be as per design type str Required if design_type is Garden, Indicates the type of garden for which the design is intended, like 'Backyard', 'Front Yard', 'Courtyard', 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 when design_type is Interior
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
house_angle
house_angle field required when design_type is Exterior
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
house_angle not provided properly
garden_type
garden_type field required when design_type is Garden
garden_type should be in ['Backyard', 'Patio', 'Terrace'...] this array will replaced dynamically as per your design_type
garden_type not provided
garden_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 /precision ? New

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] / base64 Image String The image to be processed by the API. The image dimensions must be 512x512 pixels or greater for optimal results.
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.
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 Required if design_type is Interior, Indicates the type of room for which the design is intended, like 'Living Room', 'Bedroom', 'Kitchen', etc.
house_angle House angle should be as per design type str 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'
garden_type Garden type should be as per design type str Required if design_type is Garden, Indicates the type of garden for which the design is intended, like 'Backyard', 'Front Yard', 'Courtyard', 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 512x512 or greater than 512x512 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 512x512 or greater than 512x512 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 when design_type is Interior
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
house_angle
house_angle field required when design_type is Exterior
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
house_angle not provided properly
garden_type
garden_type field required when design_type is Garden
garden_type should be in ['Backyard', 'Patio', 'Terrace'...] this array will replaced dynamically as per your design_type
garden_type not provided
garden_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 /fill_spaces ? New

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] / base64 Image String The image to be processed by the API. The image dimensions must be 512x512 pixels or greater for optimal results.
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.
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 Required if design_type is Interior, Indicates the type of room for which the design is intended, like 'Living Room', 'Bedroom', 'Kitchen', etc.
house_angle House angle should be as per design type str 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'
garden_type Garden type should be as per design type str Required if design_type is Garden, Indicates the type of garden for which the design is intended, like 'Backyard', 'Front Yard', 'Courtyard', 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 512x512 or greater than 512x512 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 512x512 or greater than 512x512 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 when design_type is Interior
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
house_angle
house_angle field required when design_type is Exterior
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
house_angle not provided properly
garden_type
garden_type field required when design_type is Garden
garden_type should be in ['Backyard', 'Patio', 'Terrace'...] this array will replaced dynamically as per your design_type
garden_type not provided
garden_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 /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] / base64 Image String The image width and height must be 512x512 or greater than 512x512 pixels.
masked_image - file[ ‘.jpg’, ’.jpeg’, ’.png’ ] / base64 Image String The image width and height must be 512x512 or greater than 512x512 pixels. Click Here to generate a mask image Video Tutorial.
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 Required if design_type is Interior, Indicates the type of room for which the design is intended, like 'Living Room', 'Bedroom', 'Kitchen', etc.
house_angle House angle should be as per design type str 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'
garden_type Garden type should be as per design type str Required if design_type is Garden, Indicates the type of garden for which the design is intended, like 'Backyard', 'Front Yard', 'Courtyard', 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 512x512 or greater than 512x512 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 512x512 or greater than 512x512 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 when design_type is Interior
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
house_angle
house_angle field required when design_type is Exterior
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
house_angle not provided properly
garden_type
garden_type field required when design_type is Garden
garden_type should be in ['Backyard', 'Patio', 'Terrace'...] this array will replaced dynamically as per your design_type
garden_type not provided
garden_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] / base64 Image String The image width and height must be 512x512 or greater than 512x512 pixels.
masked_image - file[ ‘.jpg’, ’.jpeg’, ’.png’ ] / base64 Image String The image width and height must be 512x512 or greater than 512x512 pixels. Click Here to generate a mask image Video Tutorial.
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 512x512 or greater than 512x512 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 512x512 or greater than 512x512 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"
    ]
}

  • Post /change_color_textures ?

The "/change_color_textures" endpoint utilizes sophisticated AI algorithms to modify the colors and textures of structural components, decor items, and furniture pieces within any given image. This feature is particularly useful for interior designers, architects, and homeowners looking to visualize various aesthetic options before making final decisions. By providing an intuitive interface for color and texture customization, it empowers users to creatively explore and implement design modifications, enhancing the overall appearance and feel of their spaces.

Parameters Value Datatype Description
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.
image - file[ .jpg, .jpeg, .png] / base64 Image String The image width and height must be 512x512 or greater than 512x512 pixels.
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.
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.
prompt Custom Prompt null or str An optional parameter that allows users to provide a descriptive guide for the AI, helping it understand the specific design changes desired. This could include details like the item to be modified (e.g., 'black table') and its material composition (e.g., 'made out of hardwood'), enabling more accurate and tailored design generation.
color White, Black, Grey, Blue, Red, Green, Yellow, Brown, Purple, Pink, Almond, Amethyst, Amber, Anthracite Grey, Aqua, Azure, Baby Blue, Beige, Biscuit, Blizzard Blue, Blush, Bottle Green, Brass, Bronze, Burgundy, Butterscotch, Camel, Celadon, Cerise, Cerulean, Champagne, Charcoal, Chartreuse, Chestnut, Chiffon, Chocolate, Cinnamon, Claret, Cobalt Blue, Copper, Copper Red, Coral, Cornflower Blue, Cream, Crimson, Cyan, Deep Red, Denim, Desert Sand, Dusty Rose, Electric Blue, Emerald, Emerald Green, Flamingo Pink, Forest Green, Frost Blue, Fuchsia, Ginger, Gold, Goldenrod, Granite Grey, Graphite, Harlequin, Heather, Honeydew, Ice Blue, Ivory, Jade, Jasmine, Kelly Green, Khaki, Lavender, Lemon Yellow, Lime Green, Linen, Lilac, Magenta, Mahogany, Maroon, Mauve, Midnight Blue, Mint Green, Mulberry, Mustard Yellow, Neon Green, Navy Blue, Ocean Blue, Ochre, Olive, Olive Drab, Onyx, Pastel Pink, Pearl, Periwinkle, Pewter, Pine Green, Pistachio, Plum, Powder Blue, Powder Pink, Rose Pink, Ruby, Rust, Saffron, Salmon, Sand, Sapphire Blue, Seafoam Green, Sepia, Slate Grey, Smoke Grey, Snow White, Soft Pink, Sorbet, Spruce Green, Steel Blue, Sunflower Yellow, Sunset Orange, Tan, Taupe, Teal, Tomato Red, Topaz, Turquoise, Ultramarine, Vanilla, Verdigris, Vermilion, Violet null or str This parameter enables users to specify the color to be applied to the structural element, decor, or furniture in the image. Users can choose from a wide palette of colors, allowing for precise matching or the exploration of new color schemes to enhance the item's appearance in the design.
materials Fabrics, Glass, Wood, Stone, Metal, Ceramics and Porcelain, Plastics and Polymers, Paper and Cardboard, Natural Fibers, Composite Materials null or str This parameter allows users to select from a variety of materials to apply to the item being modified. Options include but are not limited to fabrics, glass, wood, and stone. Selecting a material helps the AI to accurately replicate the texture and look of the item as per the user's preference, ensuring a realistic modification.
materials_type Wallpaper, Cardboard, Kraft, Parchment, Foil embossed, Textured, Handmade paper, Recycled paper, Flocked paper, Metallic paper, Vellum, Linen paper, Watercolor paper, Matte, Glossy null or str A secondary parameter that provides further detail on the selected material. Depending on the primary material choice, this parameter allows users to specify the finish or texture, such as 'textured', 'foil embossed', 'handmade paper', 'recycled plastic', 'linen paper', or 'matte metallic'. This level of detail ensures that the modifications not only change the material but also accurately reflect its specific characteristics, adding depth and authenticity to the design
object sofa,rug,wall etc. str object names that are available in given image, [wall, floor, ceiling, etc.]
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 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 512x512 or greater than 512x512 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.
prompt/(color, materials, materials_type)
prompt field required (if color, materials, materials_type are not provided)
Either prompt or color, materials, and materials_type must be provided.
color
color field required (if prompt is not provided)
color value is not a valid enumeration member; permitted: White, Black, Grey, Blue, Red, Green, Yellow, Brown, Purple, Pink, Almond, Amethyst, Amber, Anthracite Grey, Aqua, Azure, Baby Blue, Beige, Biscuit, Blizzard Blue, Blush, Bottle Green, Brass, Bronze, Burgundy, Butterscotch, Camel, Celadon, Cerise, Cerulean, Champagne, Charcoal, Chartreuse, Chestnut, Chiffon, Chocolate, Cinnamon, Claret, Cobalt Blue, Copper, Copper Red, Coral, Cornflower Blue, Cream, Crimson, Cyan, Deep Red, Denim, Desert Sand, Dusty Rose, Electric Blue, Emerald, Emerald Green, Flamingo Pink, Forest Green, Frost Blue, Fuchsia, Ginger, Gold, Goldenrod, Granite Grey, Graphite, Harlequin, Heather, Honeydew, Ice Blue, Ivory, Jade, Jasmine, Kelly Green, Khaki, Lavender, Lemon Yellow, Lime Green, Linen, Lilac, Magenta, Mahogany, Maroon, Mauve, Midnight Blue, Mint Green, Mulberry, Mustard Yellow, Neon Green, Navy Blue, Ocean Blue, Ochre, Olive, Olive Drab, Onyx, Pastel Pink, Pearl, Periwinkle, Pewter, Pine Green, Pistachio, Plum, Powder Blue, Powder Pink, Rose Pink, Ruby, Rust, Saffron, Salmon, Sand, Sapphire Blue, Seafoam Green, Sepia, Slate Grey, Smoke Grey, Snow White, Soft Pink, Sorbet, Spruce Green, Steel Blue, Sunflower Yellow, Sunset Orange, Tan, Taupe, Teal, Tomato Red, Topaz, Turquoise, Ultramarine, Vanilla, Verdigris, Vermilion, Violet
Either prompt or color, materials, and materials_type must be provided.
Color must be accurate from the provided suggesions.
materials
materials field required (if prompt is not provided)
materials value is not a valid enumeration member; permitted: Fabrics, Glass, Wood, Stone, Metal, Ceramics and Porcelain, Plastics and Polymers, Paper and Cardboard, Natural Fibers, Composite Materials
Either prompt or color, materials, and materials_type must be provided.
materials must be accurate from the provided suggesions.
materials_type
materials_type field required (if prompt is not provided)
materials_type should be in [Cotton, Linen, Silk, Velvet, Wool, Leather, Suede, Tweed, Chenille, Jacquard, Satin, Polyester, Nylon, Rayon, Cashmere]
color, materials, and materials_type are required. If you're not providing prompt.
materials_type must be accurate from the provided suggesions.
Object
object field required
object not provided.
Output should be in list of array depends on no of designs as shown below:

{
    "input_image": "https://storage.googleapis.com/generativeartbucket/UserGenerations/cristian/APIUser/input-20240215-102806078081.png",
    "output_images": [
        "https://storage.googleapis.com/generativeartbucket/UserGenerations/cristian/APIUser/20240215-102806078081-1.png"
    ]
}

  • Post /furniture_finder ?

The /furniture_finder endpoint leverages advanced image recognition and AI algorithms to analyze images of interiors, identifying pieces of furniture and decor within them. Once identified, it automatically matches these items with real, purchasable products from a vast database of furniture retailers. This feature is designed to simplify the shopping experience, allowing users to recreate their desired interior looks with ease. It not only identifies the items but also provides users with direct links to stores where they can buy the exact or similar items.

Parameters Value Datatype Description
image - file[ .jpg, .jpeg, .png] / base64 Image String The image width and height must be 512x512 or greater than 512x512 pixels.
Parameters Error Messages Reason
image
image field required
Invalid image format. Only PNG, JPEG and JPG images are allowed.
Image not provided
Image Format not valid.
Output should be in list of array depends on no of designs as shown below:

"resultArray": {
    "chair": [
        {
            "position": 1,
            "title": "Holden 5-pc. Dining Set in Gray / Oak by Bellanest",
            "link": "https://www.raymourflanigan.com/dining-rooms/dining-sets/holden-5-pc-dining-set-799188618",
            "source": "Raymour & Flanigan",
            "source_icon": "https://encrypted-tbn1.gstatic.com/favicon-tbn?q=tbn:ANd9GcQviLFE8S5Lakv4ft5si8rvmCbjjubzLkrM2rsrE2BJadVHrEXD2qAMAYYgP7g8YYs7viaO_bJ_YQEkDqg02a8K3retpFWhrLo_LGGmy6uM4oHukovUYmbUZK87LQ",
            "rating": 4.8,
            "reviews": 74,
            "price": {
            "value": "$559.95*",
            "extracted_value": 559.95,
            "currency": "$"
            },
            "thumbnail": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcR0saUeTbtxIFPI28Re-pNucsslbtGq0ubsyuYz1LtpOb7UOqKH"
        },
    ...
    ...
    ]
}

  • Post /full_hd ?

The newly consolidated /full_hd endpoint combines the capabilities of the former HD Scale-Up Tool and Ultra Enhancer Tool into one powerful API call. This endpoint is designed to upscale any design to high-resolution while simultaneously applying professional-grade enhancements to image clarity and lighting.

Parameters Value Datatype 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.
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.
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 /sky_colors ? New

The sky_colors endpoint offers advanced manipulation of weather conditions in images, allowing users to alter the atmosphere of a scene while keeping the building and associated elements intact. Perfect for architectural visualizations, this feature can turn a sunny day into a rainy or snowy one, providing a range of atmospheric conditions for your visual needs. This capability is particularly valuable for architects and real estate marketers who want to showcase properties under different environmental scenarios.

Parameters Value Datatype 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.
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.
weather Weather should be as per weather type str Indicates the type of weather for which the design is intended, like 'Clear Sky', 'Cloudy', 'Windy', etc.
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.
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
weather
weather field required
weather should be in ['Sunshine Color','Clear Sky','Rainy'...] this array will replaced dynamically as per your design_type
weather not provided
weather 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 /paint_visualizer ? New

The paint_visualizer endpoint offers advanced manipulation of weather conditions in images, allowing users to alter the atmosphere of a scene while keeping the building and associated elements intact. Perfect for architectural visualizations, this feature can turn a sunny day into a rainy or snowy one, providing a range of atmospheric conditions for your visual needs. This capability is particularly valuable for architects and real estate marketers who want to showcase properties under different environmental scenarios.

Parameters Value Datatype 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.
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.
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.
color_image Weather should be as per weather type file[ .jpg, .jpeg, .png] / base64 Image String The image to be processed by the API. .
rgb_color RGB color should be as per RGB color code RGB Color string code with ',' comma seperated value. Example: '183,42,42' An rgb_color value is specified with: rgb( RED , GREEN , BLUE ). Each parameter defines the intensity of the color as an integer between 0 and 255. For example, rgb(0,0,255) is rendered as blue, because the blue parameter is set to its highest value (255) and the others are set to 0. Click Here to choose the color code.

NOTE: In the event that both color_image and rgb_color are provided, color_image will be prioritized for further processing.

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.
masked_image
masked_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.
masked_image not provided
masked_image Size must be greater than 512x512.
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
color_image
The color_image is required when rgb_color is not provided.
The color image field must be an image.
The color image field must be a file of type: jpeg, png, jpg
whether the color_image or rgb_color field is required to get the results.
color_image value is not an image.
The image format is not supported for the color_image.
rgb_color
The rgb_color is required when color_image is not provided.
The rgb_color field format is invalid. Example: '183,42,42'
whether the rgb_color or color_image field is required to get the results.
rgb_color value is not in proper format.
Output should be in list of array depends on no of designs as shown below:

{
    "input_image": "https://storage.googleapis.com/generativeartbucket/UserGenerations/cristian/input-9a87be38-4cbf-4a6f-9e8c-434c0a8f73ef-2024-05-30-11-08-30.png",
    "output_images": [
            "https://storage.googleapis.com/generativeartbucket/UserGenerations/cristian/output-9a87be38-4cbf-4a6f-9e8c-434c0a8f73ef-1.png",
            "https://storage.googleapis.com/generativeartbucket/UserGenerations/cristian/output-9a87be38-4cbf-4a6f-9e8c-434c0a8f73ef-2.png",
            "https://storage.googleapis.com/generativeartbucket/UserGenerations/cristian/output-9a87be38-4cbf-4a6f-9e8c-434c0a8f73ef-2.png"
    ]
}

  • Download Generated Images ? New

To download the generated images to your local system or bypass the CORS issue while downloading the generated images.

URL Example Description
https://homedesigns.ai/downloadFileFromUrl?url=IMAGE_URL https://homedesigns.ai/downloadFileFromUrl?url=https://storage.googleapis.com/generativeartbucket/UserGenerations/cristian/output-2512855f-8b3c-4552-b8a7-a7ccc26d13d8-1.png You need to provide an image URL to this endpoint to download the image.
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.