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

Total rise (floor-to-floor height)

Required range: x >= 0
unit
enum<string>

Unit

Available options:
in,
cm
solveMode
enum<string>

Solve from

Available options:
riser,
steps
targetRiser
number

Target riser height

Required range: x >= 0
stepCount
number

Desired number of steps

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