Run calculations using any enabled template. Supports all calculator types without requiring endpoint-specific code.
Run a calculation using a template
Validates inputs against template widget definitions, creates a calculation sheet, solves it, and returns results.
path Parameters
codestring · requiredTemplate code (e.g., timberBeamASD, loadsSnowASCE7-22)
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
projectIdstring · requiredProject UUID to create the sheet in
attributesobject · requiredWidget reference IDs and their values. Use template-specific field names.
presetstringOptional preset code to apply defaults before user attributes
namestringOptional name for the created sheet
Responses
Calculation completed successfully
sheetIdstringUnique identifier for the created calculation sheet
templateCodestringTemplate code that was used
inputsobjectSummary of input values used
resultsobjectCalculation results. Format depends on template configuration.
List available calculation templates
Returns all calculation templates available for API use, including their codes, names, categories, and whether they have API output configured.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
List of available templates
templatesobject[]
Get template details
Returns detailed information about a specific template, including its input fields and available presets.
path Parameters
codestring · requiredTemplate code (e.g., timberBeamASD, loadsSnowASCE7-22)
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Template details
codestringTemplate code
namestringHuman-readable template name
categorystringTemplate category
descriptionstringBrief description of the template
fieldsobject[]Input field definitions for the template
presetsobject[]Available presets for the template
Get template presets
Returns the available presets for a template, including their default values.
path Parameters
codestring · requiredTemplate code (e.g., timberBeamASD, loadsSnowASCE7-22)
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Template presets
presetsobject[]
Validate inputs against a template
Validates the provided attributes against the template's field definitions without running a calculation. Useful for pre-flight validation before calling the calculate endpoint.
path Parameters
codestring · requiredTemplate code (e.g., timberBeamASD, loadsSnowASCE7-22)
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
attributesobject · requiredWidget reference IDs and their values to validate
presetstringOptional preset code to apply defaults before validation
Responses
Validation passed
validboolean · enumEnum values:warningsobject[]Non-fatal warnings (e.g., deprecated fields)