API Reference

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.
  • 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.