Commands › › Select By Family Name

Select By Family Name

writes to model Public API · not yet exposed

Coming soon

Before you run this

Active document must be open with a valid active view.

After it runs

Revit selection is replaced with all elements whose family/type/element name contains the search term. Returns JSON with totalSelected, totalSearched, and breakdown by family:type.

When to use this

User wants to select all downlights (search="downlight").
User wants to select all EDC_LF_ families (search="EDC_LF").
User wants to find elements of a specific type across the model.

Don't use this when

Selecting by category (use SelectByCategoryCommand — faster). Deep parameter value search (use SelectByParameterCommand). Filtering an existing selection (use FilterSelectionCommand).

Inputs

Name	Kind	Type	Required	Default	Description
`search`	config	`string`	no	—	Text to search for in family/type/element name
`category`	config	`string`	no	—	Optional Revit category to narrow search
`scope`	config	`string`	no	"view"	view (default) or model

Returns

Name	Type	Description
`Selection`	`ElementId[]`	Selected element IDs
`Summary`	`JSON`	Breakdown by family:type and count

Decision flow

check: parameters.search → required, fail if empty
check: parameters.category → optional, narrows collector for performance
check: parameters.scope == "model" → search entire model
default: search current view only

What you'll see in the chat

on start

Searching for elements by family name...
Looking for families matching your search term...
Starting family name selection...

thinking

Building element collector...
Filtering by family, type, and element name...
Applying selection to model...

on success

Selected {totalSelected} elements matching "{searchTerm}" from {scope}

on failure

Family name search 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/select_by_family_name
Request body schema (from [RestApiParam])
Response schema (from [RestApiResponse])
curl / JS / Python code examples

Keywords & intent patterns

select by family · select by name · find family · search family · select by type · filter family
Patterns: select * family * · find * family * · select * named *

Related commands	`SelectByCategoryCommand` · `SelectByParameterCommand` · `FilterSelectionCommand`
Pillar

Select By Family Name

When to use this

Inputs

Returns

Decision flow

What you'll see in the chat

REST API

Keywords & intent patterns

Related