Skip to main content
POST
Stair Rise & Run Calculator

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ioTotalRise
number
required

Total rise (floor-to-floor height)

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

Unit

Available options:
in,
cm
ioSolveMode
enum<string>

Solve from

Available options:
riser,
steps
ioTargetRiser
number

Target riser height

Required range: x >= 0
ioStepCount
number

Desired number of steps

Required range: x >= 1

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

request_id
string
credits_remaining
integer | null

Credits left in the current monthly allowance, or null when metering is disabled.