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

Real Power (kW)

Required range: x >= 0
existingPf
number

Existing Power Factor

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

Target Power Factor

Required range: 0.05 <= x <= 1
system
enum<string>

Supply

Available options:
three,
single
voltage
number

Voltage (V)

Required range: x >= 1
frequency
enum<string>

Frequency

Available options:
50,
60
connection
enum<string>

Bank Connection

Available options:
delta,
star

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.