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

Inside Diameter

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

Solve For

Available options:
velocity,
flow
flowRate
number

Volumetric Flow Rate

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

Flow Unit

Available options:
lpm,
lps,
m3h,
m3s,
gpm,
cfm
velocity
number

Velocity

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

Velocity Unit

Available options:
mps,
fps
lengthUnit
enum<string>

Diameter Unit

Available options:
mm,
in,
m,
ft

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.