Plan the materials for one room or space
plan_roomRead-onlyIdempotent
Plans one space, such as a room or a bathroom, from its size, openings and the finishes chosen, as the site's room planner does, and returns its materials list: each row with its quantity, what it still needs, what is not built and why, and labour hours. Quantities only; it does not size structure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | The kind of space: a room or a bathroom (from its size, doors and windows), or a slab, deck, driveway, fence, loft, retaining wall, exterior wall or stair. | |
| name | No | ||
| doors | No | ||
| scope | No | Scope question name → answer value, by the planner's ids. | |
| detail | No | full (the default): the whole answer. summary: the result lines, the citation line and the page only — fewer tokens to read. | full |
| inputs | No | Branch id → { calculator input id: value in its base unit }. | |
| intent | No | A trade, or everything. | |
| system | No | The unit system inputs left out open in, and the one the page link opens in. The answer comes in both. | metric |
| figures | Yes | The space's figures, by the planner's ids, each a length with its unit (a room: length, width, height, wallThickness; a fence: length, height; a stair: totalRise, width …). | |
| windows | No | ||
| finishes | No | Surface role → finish id, by the planner's ids. | |
| leaveOut | No | Branch ids to leave out. | |
| inputUnits | No | Send "base" to pass bare numbers on dimensioned inputs in base units (m, m², L, kg …), as the published test vectors are written. Without it a length, area or volume must carry its unit. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||