Endpoints
A description of all our endpoints
Health
Health Check GET
Simple health check of our server
Arguments
None.
Example Request
Request URL
https://api.applydesign.io/v1/healthExample Response
Code 200 OK
Properties
Create Property POST
Create a single property in the AD platform
Arguments
Name string
The name of the newly created property
Example Request
Request URL
https://api.applydesign.io/v1/propertiesRequest Body
{
"Name": "Property Name"
}Example Response
{
"UniqueID": string,
"Name": string
}Possible Errors
Code | Reason |
400 | Invalid parameters |
Get All Properties GET
Get all of account’s properties, ordered by date of creation (descending); Optionally paginated. For more info about pagination, see the “Getting Started/Introduction” article
Arguments
Page number
Optional. Default is 1
PageSize number
Optional. Default is 100
Example Request
Request URL
https://api.applydesign.io/v1/properties?Page={page number}&PageSize={page size}Example Response
[
{
"UniqueID": string,
"Name": string
}
]Images
Upload Image POST
Upload one or more space images to the platform. Only accepted image formats are JPG, JPEG, PNG.
For Auto-Staging capabilities, see Auto Staging article
Arguments
ImageUrl string
The URL of the externally hosted image you wish to upload to the Apply Design platform. Make sure it’s publicly accessible
PropertyUniqueID string
The UniqueId of the property to which to assign this image
ImageTypeUniqueID string
The type of the image { ”2D” / “360” }
ImageName string
The name of the image
RemoveFurniture boolean
Assign true for automatic furniture removal
AutoStaging boolean
Assign true for automatic staging for the image. See Auto Staging for instructions.
AutoStagingSettings object 🎨
Optional. Only add this parameter if AutoStaging is true. See Auto Staging for instructions.
AutoStagingPreferences object 🎨
Optional. Only add this parameter if AutoStaging is true. See Auto Staging for instructions.
Example Request
Request URL
https://api.applydesign.io/v1/imagesRequest Body
{
"Payload": [
{
"ImageUrl": string,
"PropertyUniqueId": string,
"ImageTypeUniqueId": string,
"ImageName": string,
"RemoveFurniture": boolean,
"AutoStaging": boolean,
"AutoStagingSettings": object,
"AutoStagingPreferences": object
]
}Example Response
{
"Payload": [
{
"Name": string,
"UniqueID": string
},
]
}Possible Errors
Code | Reason |
400 | Invalid parameters |
403 | Not your property |
404 | Property not found |
405 | Insuffiecient coins |
New! You can now set webhooks through the Apply Design platform which will be triggered upon upload process completion. See Webhooks to learn more.
Get All Renders of Image GET
Get all the renders of an image by its unique ID; Optionally paginated. For more info about pagination, see the “Getting Started/Introduction” article
Arguments
UniqueID number
The GUID Unique identifier of the image
Page number
Optional. Default is 1
PageSize number
Optional. Default is 100
Example Request
Request URL
https://api.applydesign.io/v1/images/renders?UniqueID={unique id}&Page={page number}&PageSize={page size}Example Response
[
{
"ID": number,
"Name": string,
"ResultImageURL": string,
"ThumbnailURL": string,
"DateCreated": Date,
"Status": enum {"in_progress", "completed", "failed"}
}
]Possible Errors
Code | Reason |
403 | Not your image |
404 | Image Not Found |
Get Processing Job Status GET
Get the status of a single image’s processing status, by its unique Id
Arguments
UniqueID string
The GUID Unique identifier of the image
Example Request
Request URL
https://api.applydesign.io/v1/images/processing_status?UniqueId={unique id}Example Response
{
"Status": enum {"in_queue", "in_progress", "completed", "disposed"}
}Possible Errors
Code | Reason |
403 | Not your image |
404 | Image not found |
Get Render Job Status GET
Get the status of a rendering job by its ID
Arguments
ID number
The ID of the rendering job
Example Request
Request URL
https://api.applydesign.io/v1/images/render_status?ID={id}Example Response
{
"Status": enum {"in_progress", "completed", "failed"}
"ResultImageURL": string,
"ThumbnailURL": string
}Take into account, that if the status is any other than “completed”, both URLs will be null.
Possible Errors
Code | Reason |
403 | Image not yours |
404 | Rendering job not found |
Get Room Types GET
Get a list of all room types to be set in an auto-staging request.
Arguments
None.
Example Request
Request URL
https://api.applydesign.io/v1/images/room_typesExample Response
[
{
"ID": number,
"Name": string
},
]Account
Get Coin Count GET
Get the amount of coins of an account. The account to be queried is the one the API key is assigned to.
Arguments
None.
Example Request
Request URL
https://api.applydesign.io/v1/account/coin_countExample Response
{
"CoinCount": number
}Guest Links
Generate Guest Link POST
Generate a guest link for an image or property that can be shared with non-registered users.
Arguments
Type string
The type of resource for which to generate a guest link. Must be either "image" or "property".
Id string
The unique identifier of the image or property.
ExpiryHours number
Optional. The number of hours the guest link should remain valid. Must be between 1 and 168 (7 days). If not provided, a default value will be used of 24 hours.
Example Request
https://api.applydesign.io/v1/account/generate-guest-link{
"Type": "image",
"Id": "unique-id",
"ExpiryHours": 24
}Example Response
{
"GuestLink": "https://app.applydesign.io/editor/unique-image-id?guest_token=encoded_token_here"
}Possible Errors
Code | Reason |
400 | Invalid parameters or resource not found |
401 | Unauthorized access |
Last updated on August 4, 2021