API Reference

Run AI Roof

post
https://api-sandbox.aurorasolar.com/tenants//designs//ai_roof/run

Generate a roof model for a design.

Note that this is an asynchronous endpoint. See the Asynchronous Endpoints appendix for more info.

Path Params
uuid
required

The ID of the tenant that the design is part of.

uuid
required

The ID of the design to generate a roof model for.

Body Params
string
enum
length ≥ 1

Which AI Roof model to use: roof_faces for AI Roof Faces, smart_roof for AI SmartRoof. Defaults to the tenant's AI Roof default setting.

Allowed:
boolean

True to run AI tree detection alongside AI Roof. Defaults to the tenant's "Run AI Trees with AI Roofs" setting. Has no effect if AI tree detection is not enabled for the tenant.

boolean

True to leave a successful roof model pending review instead of accepting it immediately. Pending models are accepted automatically one hour after completion, matching the behavior of AI Roof run in the Aurora app, and can be rejected before then with Reject AI Roof — which deletes the design. Defaults to false, which accepts the model as soon as the job succeeds.

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?