Planner

Plan a room or another space

post/plan

Request

  • Base URL: https://api.craftquantities.com/v1
  • URL: https://api.craftquantities.com/v1/plan
  • Auth: none declared

Query parameters

detail'full' | 'summary'

full (the default): the whole answer. summary: the result lines, the citation line and the page only — fewer tokens to read.

summary: the result lines, the citation and the page only (fewer tokens); full, the default: the whole answer. A POST body may carry detail instead.

format'json' | 'md'

md: the engine's Markdown report as text/markdown (or send Accept: text/markdown); json, the default.

Request body

kind'room' | 'bathroom' | 'slab' | 'deck' | 'driveway' | 'fence' | 'loft' | 'retaining-wall' | 'exterior-wall' | 'stair' required

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.

figuresobject required

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 …).

finishesobject

Surface role → finish id, by the planner's ids.

scopeobject

Scope question name → answer value, by the planner's ids.

intentstring

A trade, or everything.

leaveOutstring[]

Branch ids to leave out.

inputsobject

Branch id → { calculator input id: value in its base unit }.

namestring
system'metric' | 'imperial'

The unit system inputs left out open in, and the one the page link opens in. The answer comes in both.

inputUnits'base'

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.

Response

Every row the planner works, and the plan.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.