Materials list for a whole job (takeoff)
run_takeoffRead-onlyIdempotent
Works one whole-job takeoff, identified by its id, from the measurements given: the materials list of a job such as a slab or a deck, each line from its own calculator, with what to order, waste allowances, metric and US units, labour hours (not a price), what is not counted, a citation and the page link. It does not size structure.
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 |
| 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 |
| takeoff | Yes | A takeoff id, such as concrete-slab. | |
| leaveOut | No | Rows the reader leaves out of the job: still worked and shown, not put in the project or counted in labour. | |
| 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. | |
| allowances | No | Row → an allowance the reader sets: a percentage (cutting waste, overlap), or the option an allowance follows (a lay pattern). Row names are the takeoff's steps (the calculator slug, or the step key where one runs twice). | |
| 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||