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

Inlet flow rate

Required range: x >= 0
inletPressure
number
required

Inlet pressure (absolute)

Required range: x >= 0
pressureRatio
number
required

Pressure ratio (discharge ÷ inlet)

Required range: x >= 1
efficiency
number
required

Compressor efficiency (%)

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

Flow unit

Available options:
m3min,
m3h,
m3s,
lps,
cfm
pressureUnit
enum<string>

Pressure unit

Available options:
kpa,
bar,
psi
process
enum<string>

Compression process

Available options:
isentropic,
isothermal
gas
enum<string>

Gas

Available options:
air,
nitrogen,
oxygen,
methane,
co2,
helium,
custom
k
number

Heat capacity ratio (k = Cp/Cv)

Required range: x >= 1.001
motorEfficiency
number

Motor efficiency (%) — optional

Required range: 0 <= x <= 100

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.