Start a report's roof analysis
POSTapi.baseray.ai/v1/public/building-reports/{token}/engine/{path}
Starts the roof analysis of the report's building (buildings/{id}/solar/analysis), as a workspace that opened it starts it, without a credit; follow it with GET …/engine/buildings/{id}/solar/analysis/stream. A report includes one run a workspace would be charged a credit for: a second start answers 409 report_analysis_used without reaching the provider. A start that joins a run already in flight, a run no billable provider answers, or an engine that fails does not use it. Limited per report: 240 requests a minute with one token.
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 reads it: {building_id, running, started, provider, stream_url, …}.
Errors
- 403
- Not about the report's building (
route_forbidden). - 404
- No report has this token (
not_found). - 409
- The report is not paid (
report_not_paid), or it already ran its roof analysis (report_analysis_used). - 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 afterRetry-Afterseconds.
Every error has the same shape. Error codes.