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

Airflow (Q)

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

Duct Shape

Available options:
round,
rectangular
flowUnit
enum<string>

Airflow Unit

Available options:
cfm,
lps,
m3s,
m3h
diameter
number

Duct Diameter

Required range: x >= 0
width
number

Duct Width

Required range: x >= 0
height
number

Duct Height

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

Duct Dimension Unit

Available options:
in,
mm,
ft,
m

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.