Analyse a building's roof
analyse_roofReads one building's roof from imagery, by the buildingId an earlier result gave, and returns it plane by plane (facing, pitch, area, sunshine, panels) with the panels it can carry, their capacity and yearly yield. Use for questions about one building's roof or the solar it can carry: "what is the roof like?", "how many panels fit?", "which way do the roof planes face?". It analyses one building per request; search results already carry stored solar figures. A roof already measured is returned from the record at no analysis cost; otherwise the request itself starts a new analysis. Cost: 1 credit when a new analysis measures the roof (an estimate-only result is free), plus 1 credit to open a building the workspace has not opened in the last year. status is on_record (returned from the record), analysed (a new analysis finished), running (still in progress, usually done within about 20 seconds; a repeat request for the same building joins the same run and is never charged twice) or not_analysed (nothing covers this roof yet). When the roof could not be measured, the figures are an estimate from its footprint, marked basis estimated and planesAreAssumed true. Where the roof measured took in the roofs attached to the building, it is cut to the building's outline and marked basis measured_cut_to_outline. Where an open survey measured the planes on the building, roofSurvey says how: lidar or image_matching.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| buildingId | Yes | The baseray building id (`buildingId` in an earlier result). |