Skip to main content

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

Project description

Decor8 AI Python SDK

Table of Contents

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.

See complete documentation for Decor8 AI api for Virtual Staging and Interior Design. 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_for_room

# Mandatory Parameters
input_image_url = 'https://prod-files.decor8.ai/test-images/sdk_test_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
keep_original_dimensions = False # Optional. True or False. Generated designs retain original image's dimensions (and aspect ratio)
color_scheme = 'COLOR_SCHEME_5' # Optional
speciality_decor = 'SPECIALITY_DECOR_5' # Optional
mask_info = None #Optional. Use mask_info string returned by first invocation of generate_designs_for_room api. Helpful in speeding up api response time.

response_json = generate_designs_for_room(input_image_url=input_image_url, mask_info=mask_info, room_type=room_type, design_style=design_style, num_images=num_images, keep_original_dimensions=True, color_scheme=color_scheme, speciality_decor=speciality_decor)
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",
                "url": "http://<generated-image-path>",
                "width": 768,
                "height": 512
            }
        ]
    }
}

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)

# If you like HTTP URLs for output, use new API
from decor8ai.client import generate_inspirational_designs
response_json = generate_inspirational_designs(room_type=room_type, design_style=design_style, num_images=num_images)

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_walls_for_room

input_image_url = 'http://example.com/path/to/your/image.png'  #local-file-path or URL or bytes
response_json = prime_walls_for_room(input_image_url=input_image_url)

Upscale the image

AI generated designs may have a smaller resolution for some use-cases. Use this API to get upto 4x the original resolution of the image. Original images of upto maximum 1024px width or height or both are supported.

from decor8ai.client import upscale_image

input_image = 'path/to/your/image.png'  #local-file-path or URL or bytes
scale_factor = 2

response = upscale_image(input_image, scale_factor)

Generate captions for the interior image

If you need apt captions for an image depicting a specific interior design style in a room, use this API.

from decor8ai.client import generate_image_captions

room_type = 'livingroom'
design_style = 'frenchcountry'
num_captions = 2

response = generate_image_captions(room_type, design_style, num_captions)
Sample output

{
    "error": "",
    "message": "Successfully generated image captions.",
    "info":
    {
        "captions":
        [
            "\"Enchanting French Country Charm: Where cozy meets elegance in the heart of the living room.\"",
            "\"Step into a Parisian dream - where charm, elegance, and comfort seamlessly blend in this enchanting French country living room retreat. Get ready to indulge in rustic sophistication and let the cozy embrace of timeless design whisk you away to provincial bliss.\""
        ]
    }
}

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

Supported Color Schemes

Decor8 AI supports following color schemes.

Color Scheme Value Description
COLOR_SCHEME_0 Default
COLOR_SCHEME_1 Moss Green, Tan, White
COLOR_SCHEME_2 Gray, Sand, Blue
COLOR_SCHEME_3 Hunter Green, Red
COLOR_SCHEME_4 White, Pops of Color
COLOR_SCHEME_5 Blue, Neon
COLOR_SCHEME_6 Light Blue, Emerald
COLOR_SCHEME_7 Blue, Grass Green
COLOR_SCHEME_8 Blue, Beige
COLOR_SCHEME_9 Gray, Brown
COLOR_SCHEME_10 Black, Red
COLOR_SCHEME_11 Gray-Green, White, Black
COLOR_SCHEME_12 Blue, Gray, Taupe
COLOR_SCHEME_13 Black, Navy
COLOR_SCHEME_14 Emerald, Tan
COLOR_SCHEME_15 Forest Green, Light Gray
COLOR_SCHEME_16 Yellow, Gray
COLOR_SCHEME_17 Pink, Green
COLOR_SCHEME_18 Blush Pink, Black
COLOR_SCHEME_19 Black, White
COLOR_SCHEME_20 Blue, White

Supported Seasonal / Special Décor

Decor8 AI supports following seasonal décor.

Speciality Decor Value Description
SPECIALITY_DECOR_0 None
SPECIALITY_DECOR_1 Halloween Decor with Spooky Ambiance, Eerie Elements, Dark Colors, and Festive Accents
SPECIALITY_DECOR_2 Christmas Decor with Christmas Tree, Ornaments, and Lights
SPECIALITY_DECOR_3 Thanksgiving Decor, Fall Season Decor
SPECIALITY_DECOR_4 Fall Season Decor
SPECIALITY_DECOR_5 Spring Season Decor
SPECIALITY_DECOR_6 Summer Season Decor
SPECIALITY_DECOR_7 Winter Season Decor

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

decor8ai-0.24.tar.gz (5.7 kB view hashes)

Uploaded Source

Built Distribution

decor8ai-0.24-py3-none-any.whl (6.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page