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

Hot Fluid Inlet (Th,in)

hotOut
number
required

Hot Fluid Outlet (Th,out)

coldIn
number
required

Cold Fluid Inlet (Tc,in)

coldOut
number
required

Cold Fluid Outlet (Tc,out)

arrangement
enum<string>

Flow Arrangement

Available options:
counter,
parallel,
other
correctionFactor
number

Correction Factor (F)

Required range: 0 <= x <= 1
temperatureUnit
enum<string>

Temperature Unit

Available options:
c,
f,
k
overallCoefficient
number

Overall Heat Transfer Coefficient (U)

Required range: x >= 0
duty
number

Heat Duty (Q)

Required range: x >= 0

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.