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
units
enum<string>

Units

Available options:
metric,
imperial
material
enum<string>

Material

Available options:
music-wire,
hard-drawn,
oil-tempered,
chrome-vanadium,
chrome-silicon,
stainless-302,
stainless-316,
stainless-17-7,
phosphor-bronze,
beryllium-copper,
brass,
monel-400,
inconel-x750,
titanium,
custom
shearModulus
number

Shear modulus G

Required range: x >= 0
wireDiameter
number

Wire diameter (d)

Required range: x >= 0
coilDiameter
number

Mean coil diameter (D)

Required range: x >= 0
activeCoils
number

Active coils (n)

Required range: x >= 0
load
number

Applied load (optional)

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.