API Documentation
  • Introduction
  • API Reference
  • 🔐Authentication
  • Core APIs
    • Perfect Redesign
    • Beautiful Redesign
    • Creative Redesign
    • Sketch to Render
    • Virtual staging
    • Precision
    • Fill Spaces
    • Decor Staging
    • Furniture Removal
    • Colors & Textures
    • Furniture Finder
    • Full HD
    • Text to design
    • Furniture Creator
    • Design Advisor
    • Sky Colors
    • Design Transfer
    • Floor Editor
    • Paint Visualizer
    • Material Swap
    • Room Composer
    • Design Critique
    • Create Mask Image
    • Download Generated Images
    • Smart Home AI
  • DESIGN SCOPE
    • Interiors
      • Design Styles for Interiors
      • Room Types
      • Colors in Interior Design
      • Explore Material Options for Interior Designs
    • Exteriors
      • Design Styles for Exteriors
      • Copy of Design Styles for Exteriors
      • House angles
      • Exterior Colors
      • Material Options for Exterior Designs
    • Gardens
      • Design Styles for Gardens
      • Garden Types
      • Explore Color Options for Garden Designs
      • Material Options for Garden Designs
  • Data
    • User Details
    • Design Scope
  • Others
    • What is Masked Image?
Powered by GitBook
On this page

Was this helpful?

  1. Core APIs

Sketch to Render

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.

ENDPOINT

POST /sketch_to_render

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

Convert Sketches into photorealistic render using sketch_to_render endpoint, ideal for architects and home builders.

An API request must be in the form-data format.

Request

Parameters & Data Type
Value
Description

image

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

-

The image to be processed by the API. The image dimensions must be 512x512 pixels or greater for optimal results. (Required Parameter)

design_type

string

Interior, Exterior, Garden

Specifies the type of area you want to design. API users must specify whether they are designing an interior space, an exterior area, or a garden. (Required Parameter)

ai_intervention

string

Very Low, Low, Mid, Extreme

Indicates the level of AI intervention in the design process. "Very Low" means minimal changes, while "Extreme" allows for significant alterations to the original design. (Required Parameter)

no_design

integer

Min - 1, Max - 4

Specifies the number of design variations you want the API to generate. The minimum is 1 and the maximum is 4. (Required Parameter)

design_style

string

Design style should be as per design type.

Defines the overall aesthetic style you want to achieve, such as 'Bohemian', 'Industrial', 'Scandinavian', etc.

(Required Parameter)

Here you can see the more design styles.

room_type

string

Room style should be as per design type

house_angle string

House angle should be as per design type

garden_type string

Garden type should be as per design type

prompt

null or string

Write a Custom Prompt

An optional text prompt that can guide the AI in generating the design. This could be something like "Create a cozy and warm living room".

Parameters & Errors

image

Error Messages
Reason

Image field required

Image not provided

Invalid image size. The image width and height must be 512x512 or greater than 512x512 pixels.

Image Size Not Proper.

Invalid image format. Only PNG, JPEG and JPG images are allowed.

Image Format not valid.

design_type

Error Messages
Reason

Design_type field required

Design type not provided

Design_type value is not a valid enumeration member; permitted: 'Interior', 'Exterior', 'Garden'

design type not provided properly

room_type

Error Messages
Reason

room_type field required when design_type is Interior

room_type not provided

room_type should be in ['Living room', 'Bedroom', 'Bathroom'...] this array will replaced dynamically as per your design_type

room_type not provided properly

house_angle

Error Messages
Reason

house_angle field required when design_type is Exterior

house_angle not provided

house_angle should be in ['Side of House', 'Front of House', 'Back of House'...] this array will replaced dynamically as per your design_type

house_angle not provided properly

garden_type

Error Messages
Reason

garden_type field required when design_type is Garden

garden_type not provided

garden_type should be in ['Backyard', 'Patio', 'Terrace'...] this array will replaced dynamically as per your design_type

garden_type not provided properly

design_style

Error Messages
Reason

design_style field required

Design_style not provided

design_style should be in ['No Style', 'Eclectic', 'Modern'...] this array will replaced dynamically as per your design_type

Design_style not provided properly

ai_intervention

Error Messages
Reason

ai_intervention field required

ai_intervention not provided

ai_intervention value is not a valid enumeration member; permitted: 'Very Low', 'Low', 'Mid', 'Extreme'

ai_intervention not provided properly

no_design

Error Messages
Reason

no_design field required

no_design not provided

no_design value is not a valid enumeration member; permitted: 1, 2, 3, 4

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"
    ]
}

PreviousCreative RedesignNextVirtual staging

Last updated 4 months ago

Was this helpful?

Required if design_type is Interior, Indicates the type of room for which the design is intended, like 'Living Room', 'Bedroom', 'Kitchen', etc. to see more room types.

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'. to see more house angles.

Required if design_type is Garden, Indicates the type of garden for which the design is intended, like 'Backyard', 'Front Yard', 'Courtyard', etc. to see more garden types.

Interior Design Styles
Exterior Design Styles
Garden Design Styles
Click here
Click here
Click here
Page cover image