Skip to main content
Every Hub calculator is a template. The template endpoints work the same way for all of them: look up a calculator’s inputs, then calculate.

Endpoints

The template codes for each Hub calculator are listed in the introduction.

Example

1

Discover templates

Alongside templates, the response carries total, limit and offset. Page through with offset (?limit=20&offset=20 returns the next twenty) while offset plus the number of entries you received is less than total. Omitting limit returns up to 100. The Hub’s calculators have the category Connections.
2

Inspect a template

This returns the template’s input fields (reference IDs, types, units, defaults, enum options, and table column definitions), an outputs block describing everything a calculate call can return, and the available presets. For this template the fields include design_method, member_beam, member_column and W_s (weld size, in in).Send a number as a string tagged with exactly the field’s units, for example "W_s": "0.25 in". A field whose units is null takes a plain number. A value tagged in any other unit, even one that converts, is rejected with a 422 whose error carries type: "invalid_unit" and the expectedUnit.
3

Run a calculation

The response includes a sheetId, a sheetUrl deep link to the sheet in the app, the resolved inputs (one {value, label, units} entry per field, under the same reference IDs and units as the template’s fields), and results carrying the outputs that apply to those inputs. A field that is both settable and reported appears in both, holding the value you sent in inputs and the solved value in results.

One-shot, iterate, or batch?

All three end in the same place: solved sheets with the same results for the same inputs. They differ in how many passes you expect to make and how many designs you run at once. POST /v1/templates/{code}/calculate creates a sheet, applies your inputs, and solves it in one call. Every call creates a new sheet. Use it when one set of inputs gives you your answer. The sheet lifecycle splits that into steps on one sheet:
Use it when you expect to refine and re-solve, for example stepping up a plate thickness until the connection passes. The sheetId stays the same, so you end with one sheet holding the final design instead of a trail of near-duplicates. Bulk calculate runs the one-shot path for many designs, up to 100 in one project from a single call:
Use it for a set of connections run together, such as every beam-to-column connection on a floor. It is asynchronous: you poll instead of waiting on the response.

Key concepts

Template codes identify a calculator, such as steelConnectionHssBeamToHssMomentAISC360-22. Attributes are keyed by the template’s widget reference IDs, not API-specific names. GET /v1/templates/{code} lists them. Enum values must match one of the field’s options exactly, for example HSS10X10X.500 for a section or Gr 120 (e.g. A325) for a bolt grade. Presets apply a starting configuration before your attributes, matching the connection types in the app (for example Fin Plate or Field-Welded Seated). Validation with POST /v1/templates/{code}/validate checks inputs against the template without creating anything.

Next steps