AI Virtual Staging

Submit an AI Virtual Staging Order

Explanation

This API endpoint allows users to submit new orders within the service-ai-virtual-staging service.

---

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

---

Request Body

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

The service-ai-virtual-staging requires style as a mandatory widget. To include a widget in the request body, specify the widget's ID in selected_widgets as id and the selected widget item's ID as item_id.

{
    "order_id": string,
    "space_name": string,
    "selected_widgets" : 
    [
        {
            "id" : string,
            "item_id" : string
        }
    ]
}

• order_id: This should match the order_id returned by the Image Upload API.

• space_name: Retrieve the space_name using the service_name from the Get Spaces endpoint.
• selected_widgets:

  • id: Retrieve the id for selected_widgets based on the service_name from the Get Widgets and Items endpoint.
  • 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 a Space?

A Space refers to a specific area or room associated with the service you’re requesting. For certain services, such as AI Interior Design or Virtual Staging, the space_name field may be required to identify the room type (e.g., living room, bedroom, kitchen) or a specific project associated with the uploaded image.

Using the Get Spaces API, you can fetch all possible spaces based on the service.

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

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."

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

Virtual Staging - 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
}