Skip to main content
POST
Create Sheet

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

code
string
required

Template code (e.g., steelConnectionHssBeamToHssMomentAISC360-22)

Body

application/json
projectId
string
required

Project UUID to create the sheet in. Accepted in canonical, uppercase, braced, or unhyphenated form, as on POST /v1/templates/{code}/calculate; the response echoes the canonical form.

name
string

Optional name for the created sheet

Response

The unsolved sheet was created.

An unsolved sheet created from a template. Set inputs with PATCH /v1/sheets/{sheetId}, then solve with POST /v1/sheets/{sheetId}/solve.

sheetId
string<uuid>
required

Unique identifier for the sheet.

projectId
string<uuid>
required

Project the sheet belongs to.

templateCode
string
required

Template the sheet was created from.

status
enum<string>
required

A newly created sheet has no results yet.

Available options:
unsolved
sheetUrl
string<uri>
required

Link to the sheet in the Calcs.com app.

name
string

Sheet name.

createdAt
string<date-time>

Creation timestamp.