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

Room length

Required range: x >= 0
roomWidth
number
required

Room width

Required range: x >= 0
tileLength
number
required

Tile length

Required range: x >= 0
tileWidth
number
required

Tile width

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

Unit system

Available options:
metric,
imperial
roomShape
enum<string>

Room shape

Available options:
rectangle,
lshape
roomLength2
number

Extension length (L-shape)

Required range: x >= 0
roomWidth2
number

Extension width (L-shape)

Required range: x >= 0
groutGap
number

Grout gap

Required range: x >= 0
wastagePct
number

Wastage %

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

Tiles per box

Required range: x >= 1

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.