Commands  ›   ›  Select By Location

Select By Location

writes to model Public API · not yet exposed

Coming soon

Before you run this

Active document; xMm, yMm, zMm required (numbers in mm).

After it runs

Returns { success, count, positionMm, items }; optionally selection set.

When to use this

Don't use this when

Selecting by category/family/room — use SelectByRoomCommand. Selecting by ID — use SelectByIdsCommand.

Inputs

NameKindTypeRequiredDefaultDescription
xMm config number no X coordinate in mm
yMm config number no Y coordinate in mm
zMm config number no Z coordinate in mm
toleranceMm config number no Distance tolerance in mm (default 500)
setSelection config bool no If true, set Revit selection to elements at location

Returns

NameTypeDescription
countintNumber of elements at/near point
itemsJSONLightweight list: id, category, name

What you'll see in the chat

on start
Searching for elements near that location...
Finding elements at the specified coordinates...
thinking
Converting mm coordinates to internal feet...
Collecting elements within tolerance radius...
Filtering by distance to target point...
Building result set...
on success
Found {count} element(s) near ({xMm}, {yMm}, {zMm}).
on failure
Could not find elements at that location: {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_location
  • Request body schema (from [RestApiParam])
  • Response schema (from [RestApiResponse])
  • curl / JS / Python code examples

Keywords & intent patterns

select by location · select by coordinates · xyz · position · elements at point

Related commandsSelectByIdsCommand · SelectByRoomCommand
Pillar