Open a job or worked example on the Construction Canvas
make_canvas_linkRead-onlyIdempotent
Draws a whole-job takeoff or a worked example at the figures given as a Construction Canvas drawing and returns the link that opens it; the drawing rides in the link's fragment, so nothing is uploaded. Says what the drawing cannot carry. For quantities, not a construction drawing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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 | One step's own input, keyed "<step index>.<input id>" ("3.wastePercent"), each with its unit where it has one. | |
| market | No | Optional. A market whose own opening choice some inputs take (a UK reader's code, an IEC motor), and whose currency symbol prints the caller's own money figures. | |
| system | No | The unit system inputs left out open in, and the one the page link opens in. The answer comes in both. | metric |
| example | No | Or a worked example the canvas draws, such as attached-deck-built. | |
| figures | No | The job's own figures by id (a deck's length, a room's height), each length or area with its unit; a count as a number. They follow down every step that reads them. | |
| takeoff | No | A takeoff the canvas draws, such as concrete-slab, stud-wall or asphalt-shingle-roof. | |
| selection | No | Build-up choice id → option id, the takeoff's own (a stud size, an insulation, a cladding). Choices left out take the page's own for the system. | |
| 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. | |
| measurements | No | Measurement id → value, each length, area or volume with its unit ("12 ft", {"value": 3.6, "unit": "m"}); counts as numbers. Ids are those of the takeoff; any left out opens at the page's own figure. | |
| includeDocument | No | Also return the canvas document itself (JSON). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||