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
inputMode
enum<string>

Known Quantity

Available options:
velocity,
flow
velocity
number

Mean Velocity

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

Velocity Unit

Available options:
mps,
fps
flowRate
number

Volumetric Flow Rate

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

Flow Unit

Available options:
lpm,
m3h,
gpm,
cfm
geometry
enum<string>

Cross-section

Available options:
circular,
rectangular,
hydraulic
pipeDiameter
number

Inside Diameter

Required range: x >= 0
ductWidth
number

Duct Width

Required range: x >= 0
ductHeight
number

Duct Height

Required range: x >= 0
hydraulicDiameter
number

Hydraulic Diameter

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

Length Unit

Available options:
mm,
in,
m
fluid
enum<string>

Fluid

Available options:
water20,
water60,
seawater20,
air20,
air100,
ethanol20,
sae30,
glycerin20,
mercury20,
custom
density
number

Density (kg/m³)

Required range: x >= 0
viscosity
number

Viscosity

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

Viscosity Unit

Available options:
cp,
pas,
cst

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.