House and canvas

Draw a house on the Construction Canvas

Exactly one of house, commands or document. Returns the canvas document, everything the canvas lists for it, and a My Project file carrying the drawing.

post/drawing

Request

  • Base URL: https://api.craftquantities.com/v1
  • URL: https://api.craftquantities.com/v1/drawing
  • 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

documentobject

A Construction Canvas document (schema 1 to the canvas's current), opened and checked by the canvas's own opener.

templatestring

A Construction Canvas template's slug (the template index lists them: single-room, deck, two-car-garage …): the drawing its page shows, in the reader's system, with a link that opens it.

variantstring

With template: one of its two "what changes if" variants, by id; a wrong one is refused with the template's own list.

namestring

The project's name in the file.

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

The drawing, its list and the file that carries it.

OR

Changes

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