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
wallLength
number
required

Wall length

Required range: x >= 0
wallHeight
number
required

Wall height

Required range: x >= 0
brickLength
number
required

Brick length

Required range: x >= 0
brickHeight
number
required

Brick height

Required range: x >= 0
brickDepth
number
required

Brick depth

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

Unit system

Available options:
metric,
imperial
wallType
enum<string>

Wall type

Available options:
single,
double
openingsArea
number

Openings area (doors, windows)

Required range: x >= 0
mortarJointMetric
number

Mortar joint (mm)

Required range: x >= 0
mortarJointImperial
number

Mortar joint (in)

Required range: x >= 0
wastagePct
number

Wastage %

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

Mortar yield per bag (m³)

Required range: x >= 0
mortarYieldPerBagImperial
number

Mortar yield per bag (cu ft)

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.