One building's preview image
GETapi.baseray.ai/v1/public/buildings/{building_id}/preview.png
A 1200×630 PNG preview of one building that has a public page, for link previews and social cards. Any other building answers 404, as its page does.
Path parameters
building_idstring (uuid)required- The building's baseray id.
Response 200
The preview image.
Errors
- 404
- No such page (
not_found). - 429
- Too many requests from this address in a minute (
rate_limited); retry afterRetry-Afterseconds. - 503
- The building catalogue is unavailable right now (
unavailable); retry afterRetry-Afterseconds.
Every error has the same shape. Error codes.