Decor8 AI Python SDK
Table of Contents
- Overview
- Installation
- Configuration
- Usage
- Design With Photo
- Design Without Photo
- Priming the walls
- Upscale the image
- Change Wall Color (NEW)
- Change Kitchen Cabinet Color (NEW)
- Remodel Kitchen (NEW)
- Remodel Bathroom (NEW)
- Landscaping Designs (NEW)
- Replace Sky (NEW)
- Sketch to 3D Render (NEW)
- Remove Objects from Room (NEW)
- Generate Captions for the image
- Design Styles
- Room Types
- Color Schemes
- Seasonal Décor
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.
Use Cases
Virtual Staging for Real Estate
- Transform empty properties into beautifully staged homes instantly
- Process multiple properties in batch for large real estate portfolios
- Generate multiple design styles for the same space
- Reduce traditional staging costs by up to 97%
- Perfect for:
- Real estate listings and marketing
- Property websites and portals
- Open house presentations
- Rental property advertisements
- Commercial space visualization
Photography Service Enhancement
- Add virtual staging capabilities to existing photography services
- Differentiate your business with AI-powered staging
- Provide both traditional photos and virtually staged alternatives
- Increase revenue per property with minimal additional effort
- Ideal for:
- Real estate photographers
- Property marketing agencies
- Architectural photographers
- Interior design photographers
- Commercial property photographers
Personal Interior Design Chatbots
- Create AI-powered design assistants using Python's NLP capabilities
- Integrate Decor8 AI into conversational interfaces
- Provide instant design visualization through chat
- Offer personalized design recommendations
- Perfect for:
- Home improvement platforms
- Design consultation services
- Property management apps
- Real estate platforms
- Interior design applications
Website & App Integration
- Add virtual staging capabilities to any website or application
- Build scalable design generation systems
- Create interactive before/after comparisons
- Enable real-time design visualization
- Integrate with:
- Real estate platforms
- Property management systems
- Interior design applications
- E-commerce furniture sites
- Home improvement portals
Data Science & Enterprise Applications
- Build automated design recommendation systems
- Create ML-powered design analysis tools
- Develop custom design generation pipelines
- Integrate with existing AI/ML workflows
- Ideal for:
- Large-scale property management
- Real estate companies
- Design firms
- Property technology startups
- Marketing agencies
Start transforming spaces today with Decor8 AI's powerful Python SDK. Whether you're a developer, business owner, or service provider, our SDK provides the tools you need to bring professional virtual staging and interior design capabilities to your platform.
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
Example 1: Using Room Type and Design Style
from decor8ai.client import generate_designs_for_room
# Basic style-guided generation
input_image_url = 'https://prod-files.decor8.ai/test-images/sdk_test_image.png'
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 style parameters
color_scheme = 'COLOR_SCHEME_5' # Optional
speciality_decor = 'SPECIALITY_DECOR_5' # Optional
response_json = generate_designs_for_room(
input_image_url=input_image_url,
room_type=room_type,
design_style=design_style,
num_images=num_images,
color_scheme=color_scheme,
speciality_decor=speciality_decor
)
Example 2: Using Custom Prompt Only
from decor8ai.client import generate_designs_for_room
# Prompt-guided generation
input_image_url = 'https://prod-files.decor8.ai/test-images/sdk_test_image.png'
prompt = "A modern minimalist living space with Scandinavian influences, featuring clean lines, natural materials, and abundant natural light"
response_json = generate_designs_for_room(
input_image_url=input_image_url,
prompt=prompt,
num_images=1
)
Example 3: Using Advanced Prompt Controls
from decor8ai.client import generate_designs_for_room
# Advanced prompt-guided generation
input_image_url = 'https://prod-files.decor8.ai/test-images/sdk_test_image.png'
prompt = "A cozy reading nook with built-in bookshelves"
prompt_prefix = "high quality, photorealistic interior, professional photography"
prompt_suffix = "warm ambient lighting, detailed textures, interior design magazine quality"
negative_prompt = "cluttered, dark, cartoon, synthetic, artificial"
# Optional advanced parameters
seed = 42 # For reproducible results
guidance_scale = 7.5 # Controls how closely the model follows the prompt
num_inference_steps = 50 # Number of denoising steps
response_json = generate_designs_for_room(
input_image_url=input_image_url,
prompt=prompt,
prompt_prefix=prompt_prefix,
prompt_suffix=prompt_suffix,
negative_prompt=negative_prompt,
seed=seed,
guidance_scale=guidance_scale,
num_inference_steps=num_inference_steps,
num_images=1
)
The response is a JSON object containing the generated designs and other information:
{
"error": "",
"message": "Successfully generated designs.",
"info": {
"images": [
{
"uuid": "81133196-4477-4cdd-834a-89f5482bb9d0",
"url": "http://<generated-image-path>",
"width": 768,
"height": 512
}
]
}
}
If unsuccessful, the response will contain an error:
{
"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)
Change Wall Color (NEW)
Change wall paint colors in room images with a simple hex color code.
from decor8ai import change_wall_color
input_image_url = 'https://example.com/room.jpg'
wall_color_hex = '#D4A574' # Warm beige
response = change_wall_color(input_image_url, wall_color_hex)
Change Kitchen Cabinet Color (NEW)
Recolor kitchen cabinets to visualize different cabinet finishes.
from decor8ai import change_kitchen_cabinets_color
input_image_url = 'https://example.com/kitchen.jpg'
cabinet_color_hex = '#FFFFFF' # White cabinets
response = change_kitchen_cabinets_color(input_image_url, cabinet_color_hex)
Remodel Kitchen (NEW)
Generate kitchen remodel designs with different design styles.
from decor8ai import remodel_kitchen
input_image_url = 'https://example.com/kitchen.jpg'
design_style = 'modern'
num_images = 2
scale_factor = 2 # Optional
response = remodel_kitchen(input_image_url, design_style, num_images, scale_factor)
Remodel Bathroom (NEW)
Generate bathroom remodel designs with different design styles.
from decor8ai import remodel_bathroom
input_image_url = 'https://example.com/bathroom.jpg'
design_style = 'contemporary'
num_images = 2
response = remodel_bathroom(input_image_url, design_style, num_images)
Landscaping Designs (NEW - Beta)
Generate landscaping designs for yards and outdoor spaces.
from decor8ai import generate_landscaping_designs
input_image_url = 'https://example.com/yard.jpg'
yard_type = 'Front Yard' # Options: 'Front Yard', 'Backyard', 'Side Yard'
garden_style = 'japanese_zen' # See garden styles below
num_images = 2
response = generate_landscaping_designs(input_image_url, yard_type, garden_style, num_images)
Garden Styles
| Style | Style | Style |
|---|---|---|
| japanese_zen | mediterranean | english_cottage |
| tropical | desert | modern_minimalist |
| french_formal | coastal | woodland |
| prairie | rock_garden | water_garden |
Replace Sky (NEW)
Replace the sky in exterior property photos with different times of day.
from decor8ai import replace_sky_behind_house
input_image_url = 'https://example.com/house.jpg'
sky_type = 'dusk' # Options: 'day', 'dusk', 'night'
response = replace_sky_behind_house(input_image_url, sky_type)
Sketch to 3D Render (NEW)
Convert sketches or floor plans to photorealistic 3D rendered images.
from decor8ai import sketch_to_3d_render
input_image_url = 'https://example.com/sketch.jpg'
design_style = 'modern'
num_images = 2
render_type = 'perspective' # Options: 'perspective', 'isometric'
response = sketch_to_3d_render(input_image_url, design_style, num_images, render_type=render_type)
Remove Objects from Room (NEW)
Remove furniture and objects from room images. Optionally use a mask to specify areas.
from decor8ai import remove_objects_from_room
input_image_url = 'https://example.com/room.jpg'
mask_image_url = 'https://example.com/mask.png' # Optional
response = remove_objects_from_room(input_image_url, mask_image_url)
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 |
| urbanmodern | wabi_sabi | grandmillennial | coastalgrandmother |
| newtraditional | cottagecore | luxemodern | high_tech |
| organicmodern | tuscan | cabin | desertmodern |
| global | industrialchic | modernfarmhouse | europeanclassic |
| neotraditional | warmminimalist |
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 | openplan | boardroom |
| meetingroom | openworkspace | privateoffice |
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 |
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file decor8ai-0.3.1.tar.gz.
File metadata
- Download URL: decor8ai-0.3.1.tar.gz
- Upload date:
- Size: 18.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.6.1 CPython/3.10.5 Darwin/24.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e85dd397aff1d502f79677b46981ce7b4a7beebfca2a4951bb90170b4dc67e40
|
|
| MD5 |
7210370d23d334f2089974bec601db3d
|
|
| BLAKE2b-256 |
71c00bad19c5a3184075c850acfb293282a8d6dd63363372de9c071f0ac13acf
|
File details
Details for the file decor8ai-0.3.1-py3-none-any.whl.
File metadata
- Download URL: decor8ai-0.3.1-py3-none-any.whl
- Upload date:
- Size: 14.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.6.1 CPython/3.10.5 Darwin/24.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f94fc0e0b63265923f84f68d827c11ed52aae08db7d4537bcfd793021f497c6d
|
|
| MD5 |
3ada17962f3c52c37e1db2e375472df6
|
|
| BLAKE2b-256 |
24d66a7fcc63efea7036e18c5082a0a6ae5f5756e8f664788d799052adce9525
|