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 theorder_id
returned by the Image Upload API.space_name
: Retrieve thespace_name
using theservice_name
from the Get Spaces endpoint.selected_widgets
:id
: Retrieve theid
forselected_widgets
based on theservice_name
from the Get Widgets and Items endpoint.item_id
: Retrieve theitem_id
for each widget by using itsid
initems
key from the Get Widget and Items endpoint.


Headers
x-api-key*
{your_api_key_here}
Response
{
"order_id": string,
"image_id": string,
"eta": integer
}
Last updated