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

Load Current (A)

Required range: x >= 0.01
supplyVoltage
number
required

Supply Voltage (V)

Required range: x >= 0.1
cableLength
number
required

One-way Cable Length

Required range: x >= 0.1
lengthUnit
enum<string>

Length Unit

Available options:
ft,
m
wireGauge
enum<string>

Wire Gauge (AWG)

Available options:
1,
2,
3,
4,
6,
8,
10,
12,
14,
1/0,
2/0,
3/0,
4/0
conductor
enum<string>

Conductor Material

Available options:
copper,
aluminum
voltageSystem
enum<string>

Voltage System

Available options:
ac1,
ac3,
dc
maxVdPercent
number

Max Voltage Drop (%)

Required range: 0.1 <= x <= 20

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.