Skip to content

Latest commit

 

History

History
235 lines (186 loc) · 9.78 KB

README.md

File metadata and controls

235 lines (186 loc) · 9.78 KB
Raw

Decor8 AI HTTP API

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 http API 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.

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 Decor8AI API Key>'

Generating Interior Design with a Photo of the room

export ROOM_TYPE="livingroom"
export DESIGN_STYLE="minimalist"
export NUM_IMAGES="1"
export INPUT_IMAGE_PATH="/path/to/your/input-image.png"
export SERVER_URL="https://api.decor8.ai/generate_designs"
export COLOR_SCHEME="COLOR_SCHEME_5"
export SPECIALITY_DECOR="SPECIALITY_DECOR_5"

# Base curl command
curl -X POST $SERVER_URL \
     -H "Authorization: Bearer $DECOR8AI_API_KEY" \
     -F "room_type=$ROOM_TYPE" \
     -F "design_style=$DESIGN_STYLE" \
     -F "num_images=$NUM_IMAGES" \
     -F "input_image=@$INPUT_IMAGE_PATH" \
     -F "color_scheme=@$COLOR_SCHEME" \
     -F "speciality_decor=@$SPECIALITY_DECOR" \
     -F "keep_original_dimensions=false"


# Using input_image_url parameter
export INPUT_IMAGE_URL="https://prod-files.decor8.ai/test-images/sdk_test_image.png"
export SERVER_URL="https://api.decor8.ai/generate_designs_for_room"
curl -X POST $SERVER_URLL \
     -H "Authorization: Bearer $DECOR8AI_API_KEY" \
     -F "room_type=$ROOM_TYPE" \
     -F "design_style=$DESIGN_STYLE" \
     -F "num_images=$NUM_IMAGES" \
     -F "input_image_url=@$INPUT_IMAGE_URL" \
     -F "color_scheme=@$COLOR_SCHEME" \
     -F "speciality_decor=@$SPECIALITY_DECOR" \
     -F "keep_original_dimensions=false"


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
            }
        ]
    }
}

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

export ROOM_TYPE="livingroom"
export DESIGN_STYLE="minimalist"
export NUM_IMAGES="1"
export SERVER_URL="https://api.decor8.ai/generate_designs"
export COLOR_SCHEME="COLOR_SCHEME_5"
export SPECIALITY_DECOR="SPECIALITY_DECOR_5"

# Base curl command
curl -X POST $SERVER_URL \
     -H "Authorization: Bearer $DECOR8AI_API_KEY" \
     -F "room_type=$ROOM_TYPE" \
     -F "design_style=$DESIGN_STYLE" \
     -F "num_images=$NUM_IMAGES" \
     -F "color_scheme=@$COLOR_SCHEME" \
     -F "speciality_decor=@$SPECIALITY_DECOR" \
     -F "keep_original_dimensions=false"

Priming the walls

export SERVER_URL="https://api.decor8.ai/prime_walls_for_room"
export INPUT_IMAGE_URL="https://prod-files.decor8.ai/test-images/sdk_test_image.png"

# Base curl command
curl -X POST $SERVER_URL \
     -H "Authorization: Bearer $DECOR8AI_API_KEY" \
     -F "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.

export SERVER_URL="https://api.decor8.ai/upscale_image"
export INPUT_IMAGE_PATH="/path/to/your/input-image.png"
export SCALE_FACTOR=2

# Base curl command
curl -X POST $SERVER_URL \
     -H "Authorization: Bearer $DECOR8AI_API_KEY" \
     -F "input_image=@$INPUT_IMAGE_PATH" \
     -F "scale_factor=@$SCALE_FACTOR"

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