Skip to main content
POST
Create Project

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.

Body

application/json
name
string
required

Project name

Example:

"Office Building Renovation"

projectNumber
string

Optional project number

Example:

"2024-001"

clientName
string

Optional client name

Example:

"ABC Construction"

buildingStandard
enum<string>
default:US

Building standard/code region (US=United States, EU=Europe/Eurocode, AU=Australia, CA=Canada, NZ=New Zealand)

Available options:
US,
EU,
AU,
CA,
NZ
unitSystem
enum<string>
default:FPS

Unit system (FPS=Imperial, MKS=Metric)

Available options:
FPS,
MKS

Response

Project created successfully

projectId
string<uuid>
required

Unique identifier for the created project

name
string
required

Project name

projectUrl
string<uri>

Direct link to the project in the Calcs.com app. Always present on a successful response.