Virtual Staging

Submit 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 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 endpoint.

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

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
}