Skip to main content

Decor8 AI Python SDK

Table of Contents

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

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.11.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

decor8ai-0.11-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file decor8ai-0.11.tar.gz.

File metadata

  • Download URL: decor8ai-0.11.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.5 Darwin/23.0.0

File hashes

Hashes for decor8ai-0.11.tar.gz
Algorithm Hash digest
SHA256 75aea91ac9b11a728f1c72b04516f4ff71a7eeeb50caae4001109cbc5318b976
MD5 1a8d76f30b7db03ecf8f5339f9e8dcac
BLAKE2b-256 b88df5f3afcaa0b4045cfb266f97ce5c732573da7476833b2800ea5b1e5cb22a

See more details on using hashes here.

File details

Details for the file decor8ai-0.11-py3-none-any.whl.

File metadata

  • Download URL: decor8ai-0.11-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.5 Darwin/23.0.0

File hashes

Hashes for decor8ai-0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 b553f426c1d8bcc593564c24b9476ec8f550a2b55ca55a95a2d9962d1d28a0af
MD5 75c53e640a1d6b8104fad39ffa5c391d
BLAKE2b-256 ac75d0643d31062064300a5df2eb5bfd8a98e82e0a56424c360406437df316de

See more details on using hashes here.

Release history Release notifications | RSS feed

0.34

2 files

0.33

2 files

0.28

2 files

0.27

2 files

0.26

2 files

0.25

2 files

0.24

2 files

0.23

2 files

0.22

2 files

0.21

2 files

0.20

2 files

0.16

2 files

0.14

2 files

0.12

2 files

This release

0.11 This release

2 files

0.3.2

2 files

0.3.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page