Create a scene
Add a room picture as a scene, by upload or by URL. Adding a scene costs no credits.
https://www.skipshoot.com/api/v1/scenesUpdated
Adds a room picture to your workspace as a scene and starts finding its surfaces. It answers at once with the scene, its status analyzing; poll Retrieve a scene until it is ready. Adding a scene costs no credits.
Request
| Send | Content type | Picture field |
|---|---|---|
| A link to the picture | application/json | image_url |
| The file itself | multipart/form-data | image |
From a URL
image_urlstringrequiredA link to the picture that anyone on the internet can open, without a login. It is fetched once, when the scene is added, so it only needs to work for that moment.
namestringoptionalWhat to call the scene, up to 255 characters. Leave it out and the name comes from the file name, so
living-room.jpgbecomes “Living Room”.settingstringoptionalindoor(the default) oroutdoor. Chooseoutdoorfor a yard, patio, garden or pool area: the scene is read as an outdoor space and takes outdoor ground cover. See Render outdoor scenes.
Upload a file
imagefilerequiredThe picture, as a JPEG, PNG or WebP file.
namestringoptionalWhat to call the scene, up to 255 characters. Leave it out and the name comes from the file name, so
living-room.jpgbecomes “Living Room”.settingstringoptionalindoor(the default) oroutdoor. Chooseoutdoorfor a yard, patio, garden or pool area: the scene is read as an outdoor space and takes outdoor ground cover. See Render outdoor scenes.
Pictures that work
- JPEG, PNG or WebP, up to 30 MB.
- A real room, straight on or from a corner, with the surfaces you want to render onto in clear view.
- Even light and a sharp picture. Very dark, blurred or tightly cropped pictures give fewer surfaces, or none.
- Pictures you have the right to use. See the Terms of service.
Limits
A workspace can add up to 500 scenes a day through the API. Scenes also count toward your workspace’s image storage; when it is full, new scenes are refused with storage_full.
Response
201 Created, with scene: the new Scene. Its surfaces appear once its status is ready.
Errors
| Status | Type | When |
|---|---|---|
| 403 | storage_full | Your workspace's image storage is full. |
| 422 | invalid_request | No picture was sent, the link could not be fetched, or the file is too large or not a supported image. |
| 429 | rate_limited | Too many requests this minute, or the workspace's daily scene limit is reached. |
Every message is listed in Error messages by endpoint.
Something these pages do not answer? Email admin@skipshoot.com and we’ll help.