Sign in

v1

latestOpenAPI 3.0.02026-07-241010520.6 KB
AI Roof

Run AI Roof

Generate a roof model for a design.

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

post/tenants/{tenant_id}/designs/{design_id}/ai_roof/run

Path parameters

tenant_idstring uuid required

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

design_idstring uuid required

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

Request body

ai_roof_mode'roof_faces' | 'smart_roof'

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.

run_tree_detection_with_ai_roofboolean

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.

Example request

{
  "ai_roof_mode": "roof_faces"
}

Response

Job successfully launched.

Example response

{
  "ai_roof_job": {
    "status": "succeeded",
    "source": "api"
  }
}