Read the home
get_homeRetrieve the current home state from a 3D floor plan project, with options to filter by ids, room, area, or element types and to reduce payload using summary detail or field selection.
Instructions
Home state. detail=summary is cheapest. Ask for less instead of reading everything: ids=[…] resolves ids (group parts included), room=<id|name> and rect=[[x0,y0],[x1,y1]] read one place, kinds=[walls|rooms|dims|labels|furniture|polylines] and fields=[…] trim each row, parts=true opens groups, ndjson=true prints one element per line so a long answer can be read a slice at a time. Every piece carries bounds (plan box with angle applied) and faces (the side it opens toward). Ids share one counter per version (w1, r2, f3…) and are never reused, so a new version may start at any number.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Only these ids, group parts included, e.g. `["f833","w24"]` | |
| rect | No | Only what meets this rectangle, `[[x0,y0],[x1,y1]]` cm | |
| room | No | Only what stands inside this room, by id or name | |
| kinds | No | Only these kinds: `walls`, `rooms`, `dims`, `labels`, `furniture`, `polylines` | |
| level | No | Storey to read: an id like `lv3`, or `all`. Default: the one shown | |
| parts | No | List what is inside groups instead of only counting the parts | |
| detail | No | `summary` (counts, bounds, room areas) or `full` (default) | |
| fields | No | Keep only these fields of each element; `id` is always kept | |
| ndjson | No | One element per line (NDJSON) instead of one JSON object, each line tagged with its kind. Long answers stay readable a slice at a time |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rev | No | Plan revision | |
| dims | No | Dimensions: {id, a, b, len, off?} | |
| name | No | Project name | |
| lines | No | ndjson=true: the head, then one element per line | |
| north | No | Degrees from plan up to north, when set | |
| parts | No | Note when parts=true found no groups | |
| rooms | No | Rooms: {id, name, pts, m2, …}; with detail=summary, rows [id, name, m²] | |
| walls | No | Walls: {id, a, b, t?, h?, arc?, type?, sides?|left?, right?} | |
| bounds | No | detail=summary: [[minx,miny],[maxx,maxy]] cm | |
| counts | No | detail=summary: how many of each kind | |
| labels | No | Labels: {id, text, at, …} | |
| levels | No | Storeys: [id, name, elevation, height, selected, index, viewable, reference] | |
| warnings | No | What the read could not do as asked | |
| furniture | No | Pieces: {id, cat, at, bounds, faces, wdh?, angle?, elev?, name?, …} | |
| polylines | No | Free lines: {id, pts, t, color, …} | |
| background | No | The scanned plan under the drawing |