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

Chronological age

Required range: 1 <= x <= 120
restingHeartRate
enum<string>

Resting heart rate

Available options:
under-50,
50-60,
61-70,
71-80,
81-90,
over-90
exerciseFrequency
enum<string>

Exercise frequency

Available options:
sedentary,
light,
moderate,
active,
athlete
bloodPressure
enum<string>

Blood pressure

Available options:
optimal,
normal,
elevated,
high
bmiCategory
enum<string>

BMI category

Available options:
underweight,
normal,
overweight,
obese-1,
obese-2
dietQuality
enum<string>

Diet quality

Available options:
poor,
fair,
good,
excellent
waterIntake
enum<string>

Daily water intake

Available options:
low,
moderate,
good,
excellent
sleep
enum<string>

Average sleep

Available options:
under-5,
5-6,
7-8,
9-plus
smokingStatus
enum<string>

Smoking status

Available options:
never,
former,
light,
moderate,
heavy
alcoholConsumption
enum<string>

Alcohol consumption

Available options:
none,
light,
moderate,
heavy
stressLevel
enum<string>

Stress level

Available options:
low,
moderate,
high,
chronic
socialConnections
enum<string>

Social connections

Available options:
isolated,
limited,
moderate,
strong
mentalStimulation
enum<string>

Mental stimulation

Available options:
low,
moderate,
high,
very-high

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.