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
connectedLoadKw
number

Connected Load (kW)

Required range: x >= 0
demandFactor
number

Demand Factor (%)

Required range: 10 <= x <= 100
loadPowerFactor
number

Load Power Factor

Required range: 0.05 <= x <= 1
growthMargin
number

Future Growth Margin (%)

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

Supply

Available options:
three,
single
voltage
number

Secondary Voltage (V)

Required range: x >= 1

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.