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

Soil Resistivity ρ (Ω·m)

Required range: x >= 0.1
gridArea
number

Grid Area A (m²)

Required range: x >= 0.1
conductorLength
number

Grid Conductor Length (m)

Required range: x >= 0.1
burialDepth
number

Burial Depth h (m)

Required range: x >= 0
rodCount
number

Ground Rods

Required range: 0 <= x <= 50
rodLength
number

Length per Rod (m)

Required range: x >= 0
targetResistance
number

Target Resistance (Ω)

Required range: x >= 0.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.