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

Ceiling height

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

Unit system

Available options:
metric,
imperial
includeCeiling
boolean

Include ceiling in paintable area

doorCount
number

Doors

Required range: 0 <= x <= 10
windowCount
number

Windows

Required range: 0 <= x <= 10
finishPreset
enum<string>

Finish

Available options:
matte,
eggshell,
satin,
semigloss,
gloss,
primer,
custom
coverageRate
number

Custom coverage rate

Required range: x >= 0
coats
number

Coats

Required range: 1 <= x <= 10
canSize
number

Can size

Required range: x >= 0
wasteFactor
number

Waste factor %

Required range: 0 <= x <= 30

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.