Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
deckLength
number
required

Deck length

Required range: x >= 0
deckWidth
number
required

Deck width

Required range: x >= 0
boardWidth
number
required

Board width

Required range: x >= 0
boardLength
number
required

Board length (as sold)

Required range: x >= 0
unitSystem
enum<string>

Unit system

Available options:
imperial,
metric
boardGap
number

Gap between boards

Required range: x >= 0
joistSpacing
number

Joist spacing (on-center)

Required range: x >= 0
beamSpacing
number

Beam spacing (on-center)

Required range: x >= 0
wastePercent
number

Waste %

Required range: 0 <= x <= 30
fastenerDensity
number

Fasteners per unit area

Required range: x >= 0

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.