Skip to main content
POST
Ideal Body Weight Calculator

Authorizations

Authorization
string
header
required

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

Body

application/json
ioHeight
number
required

Height

Required range: x >= 0.1
ioSex
enum<string>

Sex

Available options:
male,
female
ioUnits
enum<string>

Units

Available options:
metric,
imperial
ioFrame
enum<string>

Body frame

Available options:
small,
medium,
large

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.