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: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 onerror.code, not the message:
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:
"type": "invalid_unit" and an expectedUnit naming the unit the field takes:
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.