AI Roof

Note that this is an asynchronous set of endpoints. See the Asynchronous Endpoints appendix for more info.

AI Roof is a tool for automatically generating a roof model for a specific design.

On a successful AI Roof run, a new roof model is added to the specified design_id. We will send an ai_roof_job_completed event after the job finishes (including if there were errors). After this event, users can open the design in Aurora and interact with the roof model. Or if you have access to the Design API, you can run AutoDesigner for the design after AI Roof finishes.

Sometimes AI Roof can fail, often due to issues with the imagery, LIDAR, or project location. If AI Roof fails, consider creating a Design Request instead.

Please be aware:

  • AI Roof is an add-on product that consumes credits.
    • Running AI Roof using the API consumes the same number of credits as running it in Sales Mode or Design Mode.
    • You will only be charged once per project.
  • Imagery and LIDAR must finish loading before you can run AI roof. Use the imagery_lidar_completed event to make sure they have finished.
    • If AI roof cannot work out the base elevation of the site's elevation data, the job fails with the message "Base elevation could not be determined for this site's DSM" (code 422_base_elevation_unavailable). Run it again; if it keeps failing, contact support.
  • You cannot run AI roof if there is already a roof model for the site. Please create a new design instead.
  • AI Roof settings (such as using AI SmartRoof vs. AI Roof Faces) will follow your tenant's settings for Sales Mode. Please edit them in app to change.

Confidence

If enabled for your tenant, a finished AI SmartRoof job also reports how confident the model is in the roof it generated:

  • confidence_level: high means the roof can be used as is. low means the score could not verify it; most are still fine, so check the roof before relying on it, and consider creating a Design Request if it has problems. More levels may be added later, so handle unknown values.
  • confidence: the underlying score, from 0 to 1. Use it if you want your own cutoff instead of confidence_level.

Both are null while the job is running, for AI Roof Faces, and when the roof could not be scored. Contact your Aurora representative to enable them.