AI HomeDesign API Docs
  • introduction
    • Getting Started
    • API Key
    • How to Use the API Key?
    • Step-by-Step Guide
  • API Endpoints
    • Getting Started with API Endpoints
    • Image Upload
    • Submit Order
      • AI Virtual Staging
      • AI Interior Design
      • AI Image Enhancement
      • AI Day to Dusk
      • AI Item Removal
      • AI Item Removal Mask
    • Get Spaces
    • Get Widgets and Items
    • Get Order Details
    • Generated Image Webhook
    • Upscale Download Webhook
    • Code Examples
      • Mask Canvas
    • Postman Workspace
  • Usage Limits and Policies
    • Rate Limit
  • Support and Contact
    • Help & Support
    • FAQs
Powered by GitBook
On this page
  • Explanation
  • Request Body
  • Headers
  • Response
  1. API Endpoints
  2. Submit Order

AI Day to Dusk

Submit an AI Day to Dusk Order

Explanation

This API endpoint allows users to submit new orders within the service-day-to-dusk service.


POST https://api.aihomedesign.com/v1/order


Request Body

Ensure that your request body is in the RAW-JSON format.

The service-day-to-dusk service requires sky style as a mandatory widget. To attach this widget to the request body, include the widget's ID in selected_widgets under id and the selected widget item's ID under item_id.

{
    "order_id":string,
    "remove_shadow": boolean,
    "selected_widgets" : 
    [
        {
            "id" : string,
            "item_id" : string
        }
    ]
}
  • order_id: This should match the order_id returned by the Image Upload API.

  • remove_shadow: This toggle determines whether shadows are removed. Set to true to remove shadows or false to keep them.

  • selected_widgets:

    • item_id: Retrieve the item_id for each widget by using its id in items key from the Get Widget and Items endpoint.

What is "Shadow Removal?"

"Remove Shadow" is a boolean option that, when enabled, eliminates shadows from the image.

What are Widgets and Items?

Widgets are options that enhance your order. Depending on the service, widgets can either be optional or mandatory. For example, a widget might let you choose a design style or color or add specific enhancements to your image.

Items are the specific values or choices available for each widget. For instance, if a widget allows you to select a style, the widget items could be options like "Modern," "Contemporary," or "Scandinavian."

Headers

Key
Value

x-api-key*

{your_api_key_here}

Response

{
   "order_id": string,
   "image_id": string,
   "eta": integer
}
{
    "error": string
    "key": string
}
PreviousAI Image EnhancementNextAI Item Removal

Last updated 3 months ago

id: Retrieve the id for selected_widgets based on the service_name from the .

Use the to see the available widgets and the items for each widget, ensuring your order is perfectly tailored to your needs.

Get Widgets and Items endpoint
Get Widgets and Items API
(Images shown in this documentation may not reflect the latest updates or design changes on the website.)
Day to Dusk - Sky Style Widget & Items (Images shown in this documentation may not reflect the latest updates or design changes on the website.)