Start a report's roof analysis
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.
Request
- Base URL: https://api.baseray.ai/v1
- URL: https://api.baseray.ai/v1/public/building-reports/{token}/engine/{path}
- Auth: none required
Path parameters
The report's token: 43 base64url characters, from the report's link (https://app.baseray.ai/report/{token}).
The building route, with the report's building's id where it carries one.
Response
The engine's answer as a workspace reads it: {building_id, running, started, provider, stream_url, …}.
Changes
No recorded changes to this operation across all 1 revision of this API.