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

Shower Flow Rate (L/min)

Required range: x >= 0.1
duration
number

Duration per Shower (min)

Required range: x >= 0.1
showers
number

Number of Showers

Required range: 1 <= x <= 500
temperatureRise
number

Water Temperature Rise (°C)

Required range: 0 <= x <= 100
waterCost
number

Water Cost (per 1,000 L)

Required range: x >= 0
energyCost
number

Energy Cost (per kWh)

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.