Run a calculation using a template
Validates inputs against template widget definitions, creates a calculation sheet, solves it, and returns results.
Running many designs at once? Bulk Calculate runs up to 100 in one call instead of one call per design.
Authorizations
Headers
Path Parameters
Body
Input values keyed by referenceId — the keys are the fields[].referenceId values from GET /v1/templates/{code}. Send each number as a string tagged with the field's published units, for example "24 ft" (a field whose units are null takes a plain number, and so do a few that list units, such as a roof slope listed as ":12"; a tagged value there is refused with a 422 that asks for the plain number), a list of rows for table fields (each row an array of values in columns[] order, numbers tagged the same way), and for enum fields an entry of that field's options copied exactly as published — including any leading or trailing whitespace, which can be the only thing separating two different options. Almost every option is a string; a few fields publish numbers, and those are accepted either as the number or as its string. Omitted fields fall back to the template's defaults (or the chosen preset's).
Response
Calculation completed successfully
Calculation results keyed by referenceId. The keys come from the template schema's outputs[] (GET /v1/templates/{code}), and a given calculation returns the subset of those that apply to the inputs you sent. Value shape depends on the output kind: numbers, booleans, strings (including multi-sentence guidance text), and arrays of row objects, which may be empty. Numeric values are returned unrounded.
Verdict of the template's governing check for this calculation. pass: the check passed (summaryCheck is true, or a number from 0 to 1). fail: the check evaluated and failed (false, or a number outside 0 to 1). error: the check could not be evaluated — summaryCheckError is true, or the solve produced no value for a check the template defines; treat it as not passing. not_evaluated: the template defines no governing check.
pass, fail, error, not_evaluated