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
length
number

Room length (ft)

Required range: 5 <= x <= 60
width
number

Room width (ft)

Required range: 5 <= x <= 60
ceilingHeight
number

Ceiling height (ft)

Required range: 7 <= x <= 20
climateZone
enum<string>

Climate zone

Available options:
cool,
moderate,
hot
insulationQuality
enum<string>

Insulation quality

Available options:
poor,
average,
good,
excellent
windowCount
number

Number of windows

Required range: 0 <= x <= 12
sunExposure
enum<string>

Window sun exposure

Available options:
shaded,
moderate,
full-sun
occupants
number

Regular occupants

Required range: 1 <= x <= 12

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.