Skip to main content
CalcsConnect uses the same structure as Calcs.com. Work created through the API is recognizable to anyone who also uses Calcs.com directly.

​
Projects

A project groups related calculations. Each user can hold multiple projects. A project is also the unit you export to PDF. When you create one, you set the building standard region and the unit system, so later calculations inherit the right context.

​
Templates and sheets

A template is a calculator. A sheet is one calculation created from that template, identified by a template code. A sheet holds its own input values and persists in the project, so you can read it back or change it later. Sheet inputs are keyed by widget reference ID. Read the available fields, their options, and the outputs a template returns from the template details endpoint.

​
Solving

Solving computes results from the sheet’s current inputs. Four behaviors are worth designing around.
  • Create and solve are separate steps. A new sheet starts unsolved. Set inputs, then solve.
  • Solving is safe to retry. Unchanged inputs produce the same results.
  • Re-solving keeps the same sheet. Update inputs and solve again, and the sheet ID does not change.
  • Updates are applied as one unit. If the template rejects a value, nothing is written and the response names the field.
A sheet reports as solved only while its stored results match the inputs it holds now. Change an input and it reads unsolved until you solve again. Check that state before showing a result to a user.

​
Reading the verdict

The governing check tells you whether the design passes. Read it from the value the template returns for its summary check, and confirm the check evaluated without error before showing a verdict.
A separate field records whether a sheet has ever passed. It is not the latest verdict. A sheet edited into failing still reports that it once passed, so read the governing check for the current result.

​
Bulk operations

Projects and sheets both support bulk delete, capped at 100 per call. These calls are not atomic. Each ID is processed independently and reported back in order, so check the results array rather than the status code alone. Endpoint detail for all of the above is on the Calcs.com developer portal.