Decor8AI Virtual Staging & Interior Design API (1.0)

URL of the input image. Make sure the image is accessible over the internet. Supported formats are - PNG, JPEG, HEIF/HEIC.

Choose from the supported room types.

Choose from the supported design styles.

Scale factor determines the image resolution. By default, the API uses scale_factor = 2 (producing images up to 1536 pixels) with no additional charge. See the table below for more details:

Notes:

1. Credits are calculated based on the image resolution requested.
2. Resolutions above 2x (scale factor > 2) incur additional credits when using the generate_designs_for_room or upscale_image API.
3. The "Max pixels" refers to the longest side of the image, while the shorter side may have equal or smaller number of pixels depending upon image's aspect ratio.
4. Credits mentioned are cumulative for each request depending on the chosen resolution.
5. If num_images > 1, then the total credits used will be num_images * credits per upscale.
6. Pricing: Pay-As-You-Go pricing uses a credit-based system where 1 credit = $0.20 per generated image (up to 1536 pixels on either dimension). By default, the API uses scale_factor = 2, producing images with maximum 1536 pixels. There is no additional charge for scale_factor ≤ 2. When scale_factor > 2, additional credits are required as shown in the table above.

Preferred color scheme, optional. Default is COLOR_SCHEME_0. Here are the possible values:

Details about any specialty decor elements, optional. Default is SPECIALITY_DECOR_0. Here are the possible values:

Additional masking information, optional. This string is returned by this end-point. You may store it and use it for future requests. This usually speeds up the process of generating images.

(Optional) Custom prompt for image generation. If provided, room_type, design_style, color_scheme, and speciality_decor values are ignored as the prompt field is used directly for image generation. If prompt is not provided, then room_type and design_style must be provided and will be used to generate a system-selected prompt. Note: Using custom prompts provides more control over image generation but may require experimentation to achieve desired results.

(Optional) Seed for reproducible results. Using the same seed with identical parameters will generate similar images. Default is random. Note: Useful for consistency across generations but results may still vary slightly.

(Optional) Controls how closely the model follows the prompt. Higher values result in images that more strictly follow the prompt but may be less natural. Lower values allow more creative freedom but may deviate from the prompt. Default is 15. Note: Finding the right balance requires experimentation.

(Optional) Number of denoising steps. Higher values can produce better quality images but take longer to generate. Lower values are faster but may reduce quality. Default is 50. Note: Balance between quality and generation time requires experimentation.

(Optional) URL of the image file to use as a style reference for the generated design. Additional 1 credit / per image is used for this request. Refer to https://www.decor8.ai/api-pricing for credit pricing. If you generate more than 1 image, then the additional credits used will be equal to the value of num_images parameter.

(Optional) Controls how strongly the design style image influences the final output. Higher values (closer to 1.0) give more weight to the style image than other inputs like room_type, design_style, or custom prompt.

(Optional) Controls the level of creative improvements in the final image. Higher values result in more creative alterations to the overall look and feel.

(Optional) Webhook configuration for asynchronous notifications as a stringified JSON string. When provided, the API will send a POST request to the specified URL when the image generation is complete.

The JSON string must have this structure:

{
  "url": "https://your-callback-url.com/webhook",  // Required
  "token": "your-auth-token",                      // Optional
  "context": "Custom context for this request"     // Optional
}

Example in JavaScript:

webhooks_data: JSON.stringify({
  url: "https://your-callback-url.com/webhook",
  token: "your-auth-token",
  context: "Custom context"
})

Example in Python:

webhooks_data = json.dumps({
  "url": "https://your-callback-url.com/webhook",
  "token": "your-auth-token",
  "context": "Custom context"
})

Choose from the supported room types.

Choose from the supported design styles.

Preferred color scheme, optional. Default is COLOR_SCHEME_0. Here are the possible values:

Details about any specialty decor elements, optional. Default is SPECIALITY_DECOR_0. Here are the possible values:

(Optional) Custom prompt for image generation. If provided, room_type, design_style, color_scheme, and speciality_decor values are ignored as the prompt field is used directly for image generation. If prompt is not provided, then room_type and design_style must be provided and will be used to generate a system-selected prompt. Note: Using custom prompts provides more control over image generation but may require experimentation to achieve desired results.

(Optional) Seed for reproducible results. Using the same seed with identical parameters will generate similar images. Default is random. Note: Useful for consistency across generations but results may still vary slightly.

(Optional) Controls how closely the model follows the prompt. Higher values result in images that more strictly follow the prompt but may be less natural. Lower values allow more creative freedom but may deviate from the prompt. Default is 15. Note: Finding the right balance requires experimentation.

The URL of the house image where the sky should be replaced. Must be a publicly accessible URL.

The image file to upscale. Max file size is 4MB.

URL of the input image. Ensure the image is accessible over the internet. Supported formats are - PNG, JPEG, HEIF/HEIC.

URL of the input image. Can be either a https:// URL or a data:// base64 encoded string. Supported formats are PNG, JPEG, HEIF/HEIC.

Note: When using data:// URLs, there is a 4MB limit on the file size.

Examples:

• HTTPS URL: https://prod-files.decor8.ai/test-images/sdk_test_image.png
• Base64 URL: data:image/jpeg;base64,BASE64_ENCODED_IMAGE_DATA

URL of the input image. Can be either a https:// URL or a data:// base64 encoded string. Supported formats are PNG, JPEG, HEIF/HEIC.

Note: When using data:// URLs, there is a 4MB limit on the file size.

Examples:

• HTTPS URL: https://prod-files.decor8.ai/test-images/sdk_test_change_kitchen_cabinets_color_2.jpg
• Base64 URL: data:image/jpeg;base64,BASE64_ENCODED_IMAGE_DATA

URL of the input image. Can be either a https:// URL or a data:// base64 encoded string. Supported formats are PNG, JPEG, HEIF/HEIC.

Note: When using data:// URLs, there is a 4MB limit on the file size.

Examples:

• HTTPS URL: "https://prod-files.decor8.ai/test-images/yard_image.jpg"
• Base64 URL: "data:image/jpeg;base64,BASE64_ENCODED_IMAGE_DATA"

The type of yard to design. Case-insensitive.

The style of garden to implement. Case-insensitive.

URL of the kitchen image to remodel. Can be either a https:// URL or a data:// base64 encoded string. Supported formats are PNG, JPEG, HEIF/HEIC.

Note: When using data:// URLs, there is a 4MB limit on the file size.

Examples:

• HTTPS URL: "https://prod-files.decor8.ai/test-images/kitchen_image.jpg"
• Base64 URL: "data:image/jpeg;base64,BASE64_ENCODED_IMAGE_DATA"

The design style to apply to the kitchen remodel.

Number of design variations to generate. Default is 1.

URL of the bathroom image to remodel. Can be either a https:// URL or a data:// base64 encoded string. Supported formats are PNG, JPEG, HEIF/HEIC.

Note: When using data:// URLs, there is a 4MB limit on the file size.

Examples:

• HTTPS URL: "https://prod-files.decor8.ai/test-images/bathroom_image.jpg"
• Base64 URL: "data:image/jpeg;base64,BASE64_ENCODED_IMAGE_DATA"

The design style to apply to the bathroom remodel.

Number of design variations to generate. Default is 1.

URL of the sketch image to convert to 3D render. Can be either a https:// URL or a data:// base64 encoded string. Supported formats are PNG, JPEG, HEIF/HEIC.

Note: When using data:// URLs, there is a 4MB limit on the file size.

Examples:

• HTTPS URL: "https://prod-files.decor8.ai/test-images/sdk_sketch_to_3d_render.png"
• Base64 URL: "data:image/jpeg;base64,BASE64_ENCODED_IMAGE_DATA"

The design style to apply to the 3D render.

Scale factor determines the image resolution. By default, the API uses scale_factor = 2 (producing images up to 1536 pixels) with no additional charge. See the table below for more details:

Notes:

1. Credits are calculated based on the image resolution requested.
2. Resolutions above 2x (scale factor > 2) incur additional credits when using the generate_designs_for_room or upscale_image API.
3. The "Max pixels" refers to the longest side of the image, while the shorter side may have equal or smaller number of pixels depending upon image's aspect ratio.
4. Credits mentioned are cumulative for each request depending on the chosen resolution.
5. If num_images > 1, then the total credits used will be num_images * credits per upscale.
6. Pricing: Pay-As-You-Go pricing uses a credit-based system where 1 credit = $0.20 per generated image (up to 1536 pixels on either dimension). By default, the API uses scale_factor = 2, producing images with maximum 1536 pixels. There is no additional charge for scale_factor ≤ 2. When scale_factor > 2, additional credits are required as shown in the table above.