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

Units

Available options:
metric,
imperial
normalMode
enum<string>

Normal force source

Available options:
weight,
direct
mass
number

Mass

Required range: 0.001 <= x <= 10000000
normalForce
number

Normal force

Required range: 0 <= x <= 100000000
material
enum<string>

Material pair

Available options:
rubber-concrete-dry,
rubber-concrete-wet,
steel-steel-dry,
steel-steel-lubricated,
aluminum-steel,
copper-steel,
wood-wood,
glass-glass,
leather-wood,
ice-ice,
teflon-teflon,
custom
muS
number

Static friction coefficient (μs)

Required range: 0 <= x <= 5
muK
number

Kinetic friction coefficient (μk)

Required range: 0 <= x <= 5
appliedForce
number

Applied (pushing) force

Required range: 0 <= x <= 100000000

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.