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

Text to design

Text-to-design is a process where text-based input or descriptions are used to generate visual designs or concepts.This can be done using various tools or software that utilize artificial intelligence or other technologies to interpret the text and create corresponding visual representations.

ENDPOINT

POST /text_to_design

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

It is a convenient and efficient way to generate design ideas based on written descriptions quickly.

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

Request

Parameters & Data Type
Value
Description

custom_instruction

string

-

By providing custom instructions, users can communicate their unique vision and style preferences to the AI system. Text-to-design is a process where text-based input or descriptions are used to generate visual designs or concepts. (Required Parameter)

Parameters & Errors

custom_instruction

Error Messages
Reason

custom_instruction field required.

You need to enter your query. Blank fields are not accepted.

mode

Error Messages
Reason

The mode field is required.

The mode type field is required to get the result.

The mode type value is not a valid enumeration member. Permitted values are: [faster, lower].

mode type not provided properly

//Output should be in list of array depends on no of designs as shown below:

{
    "output_images": [
            "https://storage.googleapis.com/generativebucketapi/UserGenerations/cristian/20230901-085649876484-1.png",
    ]
}

PreviousFull HDNextFurniture Creator

Last updated 3 months ago

Was this helpful?

Page cover image