๐Endpoints
Last updated
Last updated
The v2 API is available at the base URL https://api.virtualstagingai.app/v2
.
The same API key can be used for both the v1 and v2 API. You can find or generate your API key in the Settings section of your Virtual Staging AI account.
Authenticate all requests by including an Authorization Header with the value (case sensitive):
Authorization: Api-Key {your_api_key_here}
Returns all renders for the authenticated user
20
Render ID to start after
The order in which to display renders. Based on their creation date.
desc
Possible values: Returns details about a render including the status, variations, and result URL
The ID of the render to get details for
false
20
Variation ID to start after
The order in which to display variations. Based on their creation date.
asc
Possible values: Creates a new render with the specified parameters. If a webhook_url is provided, status updates will be sent to that URL as the render progresses.
URL for an image, either HTTP/HTTPS URL or base64 encoded data URL
^(https?:\/\/[^\s]+|data:image\/[a-zA-Z+]+;base64,[A-Za-z0-9+/=]+)$
URL to send progress updates to
false
Create one or more variations for an existing render. If a webhook_url is provided, status updates will be sent to that URL as variations progress.
false
Submits an image for analysis to generate a furniture mask. If a webhook_url is provided, completion status will be sent to that URL.
URL for an image, either HTTP/HTTPS URL or base64 encoded data URL
^(https?:\/\/[^\s]+|data:image\/[a-zA-Z+]+;base64,[A-Za-z0-9+/=]+)$
URL for completion payload