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

Prospective fault current (kA)

Required range: 0.001 <= x <= 1000
clearingTime
number
required

Disconnection time (s)

Required range: 0.001 <= x <= 60
materialPreset
enum<string>

Conductor material / insulation

Available options:
copper-pvc,
copper-xlpe,
copper-bare,
aluminum-pvc,
aluminum-bare,
steel-bare,
custom
customK
number

Custom k value

Required range: 1 <= x <= 600
minSize
enum<string>

Minimum standard size (mm²)

Available options:
0,
1.5,
2.5,
4,
6,
10,
16,
25,
35,
50,
70,
95,
120,
150,
185,
240,
300,
400,
500,
630

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.