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:

  • id: Retrieve the id for selected_widgets based on the service_name from the Get Widgets endpoint.

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

What is "Shadow Removal?"

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

(Images shown in this documentation may not reflect the latest updates or design changes on the website.)

What are Widgets and Widget 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.

Widget Items are the specific values or choices available for each widget. For instance, if a widget allows you to select sky style, the widget items could be options like "Dusk with cloud," "Dusk without cloud," or "Twilight with cloud."

Use the Get Widgets API to see the available widgets and the Get Widget Items API to explore the choices for each widget, ensuring your order is perfectly tailored to your needs.

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

Headers

Key	Value
x-api-key*	{your_api_key_here}

Response

200: OK

{
   "order_id": string,
   "image_id": string,
   "eta": integer
}

400: Bad Request

{
    "error": string
    "key": string
}