> ## Documentation Index
> Fetch the complete documentation index at: https://connectionshub.atlastube.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Connections Hub API

> Run HSS Connections Hub calculators from your own software through the Connections Hub API.

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:

```bash theme={null}
curl -X POST "https://api.calcs.com/v1/templates/steelConnectionHssBeamToHssMomentAISC360-22/calculate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "your-project-id",
    "preset": "Fin Plate",
    "attributes": {
      "design_method": "LRFD",
      "member_beam": "HSS8X4X.375",
      "member_column": "HSS10X10X.500"
    }
  }'
```

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](https://connectionshub.atlastube.com/docs/api/guides/templates.md).

| Calculator | Template code |
| - | - |
| [HSS Beam to HSS Girder Shear Connection](https://connectionshub.atlastube.com/docs/calculators/hss-to-hss/us/hss-beam-to-hss-girder-shear.md) | `steelConnectionHssBeamToHssGirderShearAISC360-22` |
| [HSS to HSS Moment Connection](https://connectionshub.atlastube.com/docs/calculators/hss-to-hss/us/hss-to-hss-moment.md) | `steelConnectionHssBeamToHssMomentAISC360-22` |
| [HSS to HSS Torsion Connection (End Plate)](https://connectionshub.atlastube.com/docs/calculators/hss-to-hss/us/hss-to-hss-torsion-end-plate.md) | `steelConnectionHssBeamToHssTorsionAISC360-22` |
| [Round HSS Longitudinal Plate Connection](https://connectionshub.atlastube.com/docs/calculators/plate-to-hss/us/round-hss-longitudinal-plate.md) | `steelConnectionHssLongitudinalPlateAISC360-22` |
| [Round HSS Transverse Plate Connection](https://connectionshub.atlastube.com/docs/calculators/plate-to-hss/us/round-hss-transverse-plate.md) | `steelConnectionHssTransversePlateAISC360-22` |
| [HSS to HSS Splice Connection (End Plate)](https://connectionshub.atlastube.com/docs/calculators/splices/us/hss-to-hss-splice-end-plate.md) | `steelConnectionHssToHssSpliceColumnAISC360-22` |
| [HSS to HSS Splice Gusset Connection](https://connectionshub.atlastube.com/docs/calculators/splices/us/hss-to-hss-splice-gusset.md) | `steelConnectionHssToHssSpliceGussetColumnAISC360-22` |
| [General HSS Truss Connection](https://connectionshub.atlastube.com/docs/calculators/truss/us/hss-truss-connection.md) | `steelConnectionHssTrussAISC360-22` |
| [Column Bracing Connection](https://connectionshub.atlastube.com/docs/calculators/bracing/us/column-bracing-double-gusset.md) | `steelConnectionColumnBracingAISC360-22` |
| [HSS Steel Base Plate](https://connectionshub.atlastube.com/docs/calculators/base-plates/us/hss-base-plate.md) | `steelConnectionHssBasePlateAISC360-22` |
| [WF Beam to Concrete-Filled HSS Moment Connection](https://connectionshub.atlastube.com/docs/calculators/composite/us/wf-to-concrete-filled-hss-moment.md) | `steelConnectionConcreteFilledMomentAISC360-22` |

`GET /v1/templates` lists every template your API key can use, with its code and name.

## API structure

| Endpoint group | Purpose |
| - | - |
| `/v1/projects` | Create, list, and delete projects, and export them to PDF |
| `/v1/templates/*` | Inspect a calculator's inputs and presets, validate, calculate, and create sheets |
| `/v1/sheets/*` | Read, update, solve, and delete sheets, and bulk calculate |

## Errors

Errors use a structured envelope. Branch on `error.code`, not the message:

```json theme={null}
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "projectId is required"
  }
}
```

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:

```json theme={null}
{
  "valid": false,
  "errors": [
    {
      "field": "member_beam",
      "label": "Beam Section",
      "value": "HSS99",
      "error": "Invalid option 'HSS99'. Valid options: 'W44X408', 'W44X368', …",
      "type": "invalid_option"
    }
  ],
  "warnings": []
}
```

A value in the wrong unit has `"type": "invalid_unit"` and an `expectedUnit` naming the unit the field takes:

```json theme={null}
{
  "field": "W_s",
  "label": "Weld Size",
  "value": "6 mm",
  "error": "W_s takes values in in, and '6 mm' uses another unit. Convert the value to in and send it in the form \"12.5 in\".",
  "type": "invalid_unit",
  "expectedUnit": "in"
}
```

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

> [card] [Authentication](https://connectionshub.atlastube.com/docs/api/authentication.md)
>
> Send your API key with every request.

> [card] [Quick start](https://connectionshub.atlastube.com/docs/api/quickstart.md)
>
> Create a project and run your first connection.

> [card] [Templates](https://connectionshub.atlastube.com/docs/api/guides/templates.md)
>
> Find a calculator's inputs and run it.

> [card] [API reference](https://connectionshub.atlastube.com/docs/api/reference/projects/create-project.md)
>
> Every endpoint, with request and response schemas.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.