Central Fatigue Index API¶
Return CNS fatigue score, neural recovery status, and heavy/light/rest stimulus recommendation with actionable recovery guidance.
Endpoint¶
GET /api/v1/fitness/central-fatigue-indexPOST /api/v1/fitness/central-fatigue-index/post
Parameters¶
| Name | Type | Required | In | Description |
|---|---|---|---|---|
sleep_hours | number (0-16) | Yes | Query/Body | Last-night sleep duration. |
resting_hr | number (30-120) | Yes | Query/Body | Resting heart rate (bpm). |
hrv | number (10-200) | Yes | Query/Body | HRV in milliseconds. |
motivation_level | integer (1-10) | Yes | Query/Body | Subjective drive/readiness. |
reaction_time_ms | number (120-800) | No | Query/Body | Optional reaction time signal. |
lang | string | No | Query | Response language (en,es,de,fr,pt,ja,hi,ar). |
Why Use This Endpoint¶
- Bring readiness science into daily programming.
- Prevent overreaching from accumulated CNS fatigue.
- Drive explainable heavy/light/rest recommendation engines.
Request Example¶
curl -X GET "https://api.hefitapi.com/api/v1/fitness/central-fatigue-index?sleep_hours=6.4&resting_hr=68&hrv=46&motivation_level=5&reaction_time_ms=305&lang=en" \
-H "X-API-Key: YOUR_API_KEY"
curl -X POST "https://api.hefitapi.com/api/v1/fitness/central-fatigue-index/post?lang=en" \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{"sleep_hours":6.4,"resting_hr":68,"hrv":46,"motivation_level":5,"reaction_time_ms":305}'
Response Example¶
Info
The response example below is for demonstration purposes only. Make a live request to this endpoint to receive the full, real-time, and potentially richer JSON structure.
{
"cns_fatigue_score": 58,
"neural_recovery_status": {
"status": "fatigued",
"status_label": "Fatigued",
"insight": "Recovery is incomplete; reduce neural load today."
},
"stimulus_recommendation": {
"target": "light",
"target_label": "Light",
"session_note": "Favor technique and quality over max output."
},
"fatigue_component_load": {
"sleep_load": 12.8,
"autonomic_load": 28.1,
"motivation_load": 8.0,
"reaction_load": 4.4
},
"inputs": {
"sleep_hours": 6.4,
"resting_hr_bpm": 68.0,
"hrv_ms": 46.0,
"motivation_level": 5,
"reaction_time_ms": 305.0
},
"recovery_recommendations": ["Reduce CNS load", "Prioritize sleep quality"],
"next_review_window_hours": 18,
"summary": "Central fatigue is elevated and should be managed.",
"language": "en",
"_enterprise": {
"client": "Acme Health",
"plan": "pro",
"request_id": "0ab43e1d95ca77df",
"quota": 120,
"usage_tracking": true
},
"_api_metadata_": {
"endpoint_name": "fitness_central_fatigue_index",
"response_language": "en"
}
}
Commercial Positioning¶
A premium differentiator for athlete-monitoring, recovery AI, and enterprise coaching platforms.
Note
reaction_time_ms is optional; all other readiness inputs are required.
Recommended Endpoints¶
GET /api/v1/ponderal-index- Ponderal Index APIGET /api/v1/bmi- Bmi APIGET /api/v1/tdee- Tdee APIGET /api/v1/bmr- Bmr APIGET /api/v1/protein-calculator- Protein Calculator APIGET /api/v1/fitness/heart-rate-zones- Heart Rate Zones API