Skip to main content
Every HSS Connections Hub calculator can also be driven through the Connections Hub API. Your software sends the inputs, the API creates and solves the calculation, and you get the results back as JSON. Each calculation is saved as a sheet you can open in the app or export as a PDF report.

What you can do

  • Run any Hub calculator by its template code, with the same inputs you set in the app
  • Iterate on one design: create a sheet, change inputs, and re-solve until it passes
  • Run up to 100 calculations at once with bulk calculate
  • Export reports for a project as a single PDF
  • Organise and clean up projects and sheets

Quick example

Run an HSS to HSS moment connection (fin plate, LRFD) in one call:
The response carries a sheetId, a sheetUrl that opens the sheet in the app, the resolved inputs, the results, and the governing check as summaryCheck.

Hub calculator template codes

Each calculator is identified by a template code. Use these with the template endpoints. GET /v1/templates lists every template your API key can use, with its code and name.

API structure

Errors

Errors use a structured envelope. Branch on error.code, not the message:
Some errors add a details array naming each problem field.

Invalid inputs on validate and calculate

POST /v1/templates/{code}/validate and POST /v1/templates/{code}/calculate report invalid input values differently. They return 422 with one entry per invalid field, not the envelope. Abbreviated:
A value in the wrong unit has "type": "invalid_unit" and an expectedUnit naming the unit the field takes:
Request errors on these two endpoints that are not about input values, such as a missing projectId (400) or an unknown template (404), still use the envelope.

Next steps

Authentication

Send your API key with every request.

Quick start

Create a project and run your first connection.

Templates

Find a calculator’s inputs and run it.

API reference

Every endpoint, with request and response schemas.