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

Cohesion (c)

Required range: x >= 0
frictionAngle
number
required

Friction angle (φ)

Required range: 0 <= x <= 45
unitWeight
number
required

Soil unit weight (γ)

Required range: x >= 0
footingWidth
number
required

Footing width (B)

Required range: x >= 0
footingDepth
number
required

Footing depth (Df)

Required range: x >= 0
factorOfSafety
number
required

Factor of safety (FS)

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

Unit system

Available options:
si,
us
footingShape
enum<string>

Footing shape

Available options:
strip,
square,
circular,
rectangular
soilCondition
enum<string>

Failure mode

Available options:
general,
local
footingLength
number

Footing length (L)

Required range: x >= 0

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.