Commands  ›   ›  Check Clashes

Check Clashes

writes to model Public API · not yet exposed

Coming soon

Before you run this

Active document must be open. Either elements must be selected or elementIds parameter provided.

After it runs

Default: QA XML written beside the RVT and JSON summary in LastQueryResult. JSON mode: clash pairs with overlap bounds in LastQueryResult (no XML written).

When to use this

Don't use this when

Clashes against linked models (use CheckClashesLinkedCommand). Resolving clashes automatically (use separate resolution commands).

Inputs

NameKindTypeRequiredDefaultDescription
elementIds config string no Optional JSON array of element IDs to check
outputMode config string no Output mode: 'xml' writes QA XML (default), 'json' returns lightweight JSON only

Returns

NameTypeDescription
ResultJSONClash pairs with overlap bounds, or QA XML summary

What you'll see in the chat

on start
Running clash check on the selected elements...
Checking for interferences...
thinking
Collecting elements for clash analysis...
Running bounding box intersection tests...
Compiling clash results...
on success
Found {count} clashes in the model.
on failure
Clash check failed: {error}

REST API

Not yet exposed

This command does not carry a [RestApi] attribute today. Once tagged, this section will auto-populate with:

  • POST /api/v1/commands/check_clashes
  • Request body schema (from [RestApiParam])
  • Response schema (from [RestApiResponse])
  • curl / JS / Python code examples

Keywords & intent patterns

check clashes · interference check · find clashes · clash detection · MEP clashes
Patterns: check * clashes · run * interference · find * clashes · detect * clashes

Related commandsCheckClashesLinkedCommand · SectionBoxAroundClashesCommand
Pillar