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>

Unit system

Available options:
metric,
imperial
diameter
number

Tool diameter

Required range: x >= 0
teeth
number

Number of teeth / flutes (Z)

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

Workpiece material

Available options:
aluminium,
brass,
bronze,
copper,
cast-iron,
mild-steel,
alloy-steel,
stainless-304,
tool-steel,
titanium,
inconel,
plastic,
wood
toolMaterial
enum<string>

Tool material

Available options:
carbide,
hss
cuttingSpeed
number

Cutting speed Vc (optional)

Required range: x >= 0
feedPerTooth
number

Feed per tooth fz (optional)

Required range: x >= 0
depthOfCut
number

Axial depth of cut ap (optional)

Required range: x >= 0
widthOfCut
number

Radial width of cut ae (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.