Skip to content
Sign in Sign up

A report's building record

GETapi.baseray.ai/v1/public/building-reports/{token}/engine/{path}

One record of the report's building, as a workspace that opened it reads it, without a credit: its row (buildings/search?key={id}, that key alone, marked locked: false), solar figures (buildings/{id}/solar), addresses (buildings/{id}/addresses), registered businesses (buildings/{id}/registered-companies), 3D model (buildings/{id}/model3d), register record (v2/buildings/{id}/register), the panel detection's photo (buildings/{id}/solar-panel-detection/proof.jpg, a JPEG) and the progress of its roof analysis (buildings/{id}/solar/analysis/stream, an event stream). Anything else is refused. Limited per report: 240 reads a minute with one token, the report's order included.

Path parameters

tokenstringrequired
The report's token: 43 base64url characters, from the report's link (https://app.baseray.tech/report/{token}).
pathstringrequired
The building route, with the report's building's id where it carries one.

Response 200

The engine's answer as a workspace that opened the building reads it at /api/teams/{team}/baseray/engine/{path}: JSON, the roof analysis's event stream, or the proof photo (JPEG).

Errors

403
Not about the report's building (route_forbidden).
404
No report has this token (not_found).
409
The report is not paid: its Checkout is still open or closed unpaid (report_not_paid).
410
The report's access has ended (report_access_expired).
429
Too many reads with this report's token in a minute (rate_limited); retry after Retry-After seconds.

Every error has the same shape. Error codes.