Commands › General › Place Family
Place Family
Coming soon
Before you run this
Active document must be open with a plan or 3D view. The specified family must be loaded in the document.
After it runs
A FamilyInstance is created at the specified coordinates. The new instance is selected in the UI.
When to use this
- User wants to place a specific family at an exact XY coordinate and height.
- AI needs to place equipment, fixtures, or devices at computed positions.
Don't use this when
Loading families into the document (use ImportWithCloudFamiliesCommand). Placing multiple instances at once (use batch placement command). Placing families by picking points interactively.
Inputs
| Name | Kind | Type | Required | Default | Description |
|---|---|---|---|---|---|
familyName |
config | string |
no | — | Family name to place |
typeName |
config | string |
no | — | Optional type name in that family |
x |
config | number |
no | — | X coordinate in mm |
y |
config | number |
no | — | Y coordinate in mm |
heightMm |
config | number |
no | 0 | Height above level in mm |
hostType |
config | string |
no | "auto" | Optional host type: auto|level|ceiling|void|wall|floor |
rotationDeg |
config | number |
no | 0 | Optional rotation in degrees |
Returns
| Name | Type | Description |
|---|---|---|
Result | JSON | Placement result |
What you'll see in the chat
on start
Placing family instance at the specified location...
Inserting {familyName} into the model...
Inserting {familyName} into the model...
thinking
Resolving family symbol...
Determining host type...
Creating family instance...
Determining host type...
Creating family instance...
on success
Placed {family} ({type}) at ({x}, {y}) — ID {id}.
on failure
Could not place family: {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/place_family- Request body schema (from
[RestApiParam]) - Response schema (from
[RestApiResponse]) - curl / JS / Python code examples
Keywords & intent patterns
place family · insert family · add family instance · family placement · drop family
Patterns: place * family * · insert * family * · add * family *
Related
| Pillar | General |
|---|