Aurora’s 3D Modeling Service allows users to request 3D models within the Aurora application. 3D models can also be requested via the API. The 3D Modeling Service is a paid service. You must have sufficient credits available to make a 3D Modeling Request (aka a design request). You can only request designs for residential projects.
Once you make a design request, a team of professional CAD designers will create an accurate 3D model of your work site (including buildings and trees). The requests are fulfilled during business hours. Our team aims to complete them within 3 hours. As an organization, you then have the choice between manually reviewing the designed 3D model in the Aurora application, or programmatically accepting it without a review via the API. The choice allows you to strike an appropriate balance of speed vs. quality given your specific business constraints. For example, you can accept 90% of all design requests in CA via the API and leave the 10% for a manual review, while manually reviewing all design requests in other states. Please note: once you have accepted a completed 3D model, a Design containing the model of the site will automatically be created in the Project.
Each design request has a status. There are 3 possible flows of a design request through the state machine.
- A design request object is created and is rejected by the CAD designers. No 3D model is generated. The state transition for that design request object is:
submitted => designer_rejected.
This can occur due to:
missing or unclear imagery for the project location.
an ambiguous project location where the designer is unclear which building needs to be modelled, e.g. the project marker falls on a street or between two large homes.
the building displayed is a commercial roof top, which is currently not supported.
A design request object is created and afterwards successfully fulfilled by our professional designers. You accept the design request and it is then converted into an actual design object within the project. You can accept the design request manually through the Aurora application or programmatically via the API. The state transition for that design request object is:
submitted => designer_completed => accepted.
A design request object is created and afterwards successfully fulfilled by our professional designers. You manually review the design request through the Aurora application. The quality of the generated 3D model does not meet your expectations and you reject the request. A rejection always requires feedback because it allows us to improve the quality of the service. The rejection is not possible via the API. The state transition for that design request object is:
submitted => designer_completed => rejected.
Please note that only one design request can be in progress (in either status
designer_completed) for a given Project at any given time.
Testing your Integration
To facilitate testing your integration, there are several addresses with special behavior that mock the process without using credits or requiring manual intervention.
If you submit a design request for one of the following addresses (including submitting a lat/long coordinate that falls on the roof of one of the addresses), the API will mimic the process of manual fulfillment instantly. This includes populating the design, updating the status to
designer_completed, and making a webhook call if webhooks are configured for the
|901 Mears Ct, Stanford, CA 94305, USA||Gabled roof with a dormer and a vertical fold|
|634 Mirada Ave, Stanford, CA 94305, USA||Simple hipped roof|
|419 10th Ave, Belmar, NJ 07719, USA||Gabled roof|
|7126 Casita Dr, Magnolia, TX 77354, USA||Roof with dormers|
If you submit a design request for the following address (including submitting a lat/long coordinate that falls on the roof of the address), the API will mimic the process of manual rejection. This includes setting the status to
designer_rejected, setting a rejection reason, and making a webhook call if configured for the
|600 Montgomery St, San Francisco, CA 94111||TransAmerica Pyramid in downtown San Francisco||commercial building|