decor8ai 0.12

Decor8 AI is an AI Interior Design Tool. With Decor8 AI Python SDK, you can automate interior design generation tasks for room photos.

Decor8 AI Python SDK

Table of Contents

• Overview
• Installation
• Configuration
• Usage
  • Design With Photo
  • Design Without Photo
  • Priming the walls
• Design Styles
• Room Types

Overview

Decor8 AI is a cutting-edge interior design app that revolutionizes your design experience. It offers a rich tapestry of customization options allowing you to visualize and craft interiors that echo your style and imagination.

You can choose from 35+ interior design styles and 20+ room types to create unique interior design styles for your space.

The app specializes in virtual staging, transforming empty spaces into vivid, attractive interiors, enhancing their appeal for better marketability.

Equipped with a powerful Python SDK, Decor8 AI facilitates seamless integrations, enabling enhanced design generation capabilities directly within your Python environment. Its user-friendly interface is optimized for performance on smaller screens, ensuring that your design process is as effortless and efficient as possible.

This documentation describes how you can use Decor8 AI Python SDK to integrate Decor8 AI's powerful features in your application.

Please reach out to Decor8 AI Team with questions or suggestions.

Installation

You can install the Decor8 AI Python SDK using pip:

pip install decor8ai

Configure Decor8 AI API key

Sign in to Decor8 AI

Click on Profile Photo on Top Left

Click Generate API Key

Usage

export DECOR8AI_API_KEY='<YOUR_API_KEY>'

Generating Interior Design with a Photo of the room

from decor8ai.client import generate_designs

# Mandatory Parameters
input_image = 'path/to/your/image.png'  #local-file-path or URL or bytes
room_type = 'livingroom' # See below for all supported room types
design_style = 'frenchcountry' # See below for all supported design Styles
num_images = 1 # Up to 4 images can be generated at a time

# Optional Parameters
num_captions = None # Choose 1 or 2 for number of image captions to generate

response_json = generate_designs(input_image=input_image, room_type=room_type, design_style=design_style, num_images=num_images, num_captions=1)

# The response is a JSON object containing the generated designs and other information.
# Sample response for successful design generation
# {
#     "error": "",
#     "message": "Successfully generated designs.",
#     "info":
#     {
#         "images":
#         [
#             {
#                 "uuid": "81133196-4477-4cdd-834a-89f5482bb9d0",
#                 "data": "<base64-encoded_data>",
#                 "width": 768,
#                 "height": 512,
#                 "captions":
#                 [
#                     "Unveiling the art of rustic elegance in this French Country haven, where warmth and sophistication meet effortlessly."
#                 ]
#             }
#         ]
#     }
# }

# Sample response when unsuccessful. "error" will be non-empty value.
# {
#     "error": "InvalidInput",
#     "message": "Invalid input image. Please check the input image and try again.",
# }

Generating Inspirational Interior Design Ideas without using a photo of the room

from decor8ai.client import generate_designs

# Here, we don't provide input image. The API generates a new interior design using following parameters.
room_type = 'livingroom' # See below for all supported room types
design_style = 'frenchcountry' # See below for all supported design Styles
num_images = 1 # Up to 4 images can be generated at a time

# Optional Parameters
num_captions = None # Choose 1 or 2 for number of image captions to generate

response_json = generate_designs(room_type=room_type, design_style=design_style, num_images=num_images, num_captions=1)

Priming the walls

If your room contains unfinished walls, unpainted walls or walls which need touch-up, use this API to get walls with basic white colored, smooth textured walls or as it's called 'primed walls'.

You can use the returned image as input to generate_designs API for filling it with furniture.

from decor8ai.client import prime_the_room_walls

input_image = 'path/to/your/image.png'  #local-file-path or URL or bytes
response_json = prime_the_room_walls(input_image=input_image)

Supported Design Styles

Decor8 AI supports following design styles. Learn more about these styles at Decor8 AI Decoration Styles

Design Styles
minimalist	scandinavian	industrial	boho
traditional	artdeco	midcenturymodern	coastal
tropical	eclectic	contemporary	frenchcountry
rustic	shabbychic	vintage	country
modern	asian_zen	hollywoodregency	bauhaus
mediterranean	farmhouse	victorian	gothic
moroccan	southwestern	transitional	maximalist
arabic	japandi	retrofuturism	artnouveau

Supported Room Types

Decor8 AI supports following room types. Learn more about these room types at Decor8 AI Room Types

Room Type
livingroom	kitchen	diningroom	bedroom
bathroom	kidsroom	familyroom	readingnook
sunroom	walkincloset	mudroom	toyroom
office	foyer	powderroom	laundryroom
gym	basement	garage	balcony
cafe	homebar	study_room	front_porch
back_porch	back_patio