🛣️Endpoints
A directory of all Virtual Staging AI API endpoints.
Test your setup
GET
https://api.virtualstagingai.app/v1/ping
Use this endpoint to test that your setup is working correctly. Returns some data about your account.
Headers
Name | Type | Description |
---|---|---|
Authorization | String | Set to "Api-Key {your_api_key_here}" |
Returns:
Create a new render
POST
https://api.virtualstagingai.app/v1/render/create
This is the main endpoint of the API. It allows you to perform the following actions:
Create a staging render: Add virtual furniture to an image.
Create a decluttered render: Remove existing furniture from an image.
Create a decluttered + staging render: Remove existing furniture and add new virtual furniture to the same image.
How to Use:
To create a staging render (adding virtual furniture):
Set the required fields:
image_url
,room_type
,style
.Set the
declutter_mode
parameter to'off'
(default).The image will be virtually staged with new furniture based on the provided style and room type.
To create a decluttered render (removing existing furniture without adding new furniture):
Set the required field:
image_url
.Set the
declutter_mode
to'on'
.Set the
add_furniture
parameter tofalse
.This will only remove existing furniture, and the output will include the decluttered image.
To create a decluttered + staging render (removing existing furniture and adding new furniture):
Set the required fields:
image_url
,room_type
,style
.Set the
declutter_mode
to'on'
or'auto'
.Ensure the
add_furniture
parameter istrue
(default).The output will include two images: one with the furniture removed and another with the new furniture added.
Maximum concurrency per API account: 50.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Set to "Api-Key {your_api_key_here}" |
Request Body
Name | Type | Description |
---|---|---|
image_url* | String | URL of the image to add furniture to. If not provided, use the "file" parameter for form data uploads. |
room_type* | String | The type of room in the uploaded photo. Must be one of:
|
style* | String | The desired style of furnishing. Must be one of the following: |
resolution | String | Resolution of the output image. Must be |
file | File | Form data field to pass an image directly (if not using |
wait_for_completion | Boolean | If |
add_virtually_staged_watermark | String | Adds a small "Virtually Staged" disclaimer in the lower right corner of the rendered image |
declutter_mode | String | Decluttering options:
- |
declutter_mask_url | String | URL of a black-and-white image to use as a mask for decluttering instead of automatically generating a mask. Use this if you want to allow your users to draw their own mask to decide which furniture gets removed and which doesn't. |
add_furniture | Boolean | If |
Returns:
Store the Render ID if you wish to create further variations for this photo, or look up the render state using GET /v1/render
Get an existing render
GET
https://api.virtualstagingai.app/v1/render
Use this to retrieve information about an existing render (e.g. show your users progress after starting a render with wait_for_completion=false
).
This is available right after a render is created, even if the render status is rendering
, so you can get the render info even if the render isn't done yet.
Query Parameters
Name | Type | Description |
---|---|---|
render_id* | String | The render ID returned from |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Set to "Api-Key {your_api_key_here}" |
Returns:
Create a variation for an existing render
POST
https://api.virtualstagingai.app/v1/render/create-variation
Creates a variation for an existing render. The render has to have been created using /v1/render/create
beforehand.
All the same settings (room_type
, etc.) from the first call will be used.
The render has to be in status done
to start a new variation. The maximum amount of variations per render is 20.
Query Parameters
Name | Type | Description |
---|---|---|
render_id | String | The render ID returned from |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Set to "Api-Key {your_api_key_here}" |
Request Body
Name | Type | Description |
---|---|---|
wait_for_completion | Boolean | If false, you'll get a response like So when you retrieve the render object using |
roomType | String | The type of room for the new variations. Must be one of: |
style | String | The desired style of furnishing for the new variation. Must be in the following array: |
add_virtually_staged_watermark | boolean | |
switch_to_queued_immediately | boolean | If true, will immediately switch render into "queued" status, then into "rendering" once the photo starts rendering. |
Returns:
Store the Render ID if you wish to create further variations for this photo, or look up the render state using GET /v1/render
.
If wait_for_completion
was false
, only the render_id
will be returned and you'll have to look up the render state using GET /v1/render
. Then, the output image of your variation will be appended to the outputs
array and status
will be rendering
until the variation is done.
Get available room types & styles
GET
https://api.virtualstagingai.app/v1/options
Returns the available styles and room types. They need to be passed into other endpoints exactly as the same strings as returned here.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Set to "Api-Key {your_api_key_here}" |
Returns:
Last updated