Skip to content

Recovery Score API

Generate a daily recovery readiness score and action plan from core recovery biomarkers.

Endpoint

  • GET /api/v1/fitness/recovery-score
  • POST /api/v1/fitness/recovery-score/post

Parameters

Name Type Required In Description
sleep_hours number (0-16) Yes Query/Body Sleep duration in hours.
resting_hr number (30-120) Yes Query/Body Resting heart rate in bpm.
hrv number (10-200) Yes Query/Body HRV in milliseconds.
muscle_soreness number (0-10) Yes Query/Body Perceived soreness score.
lang string No Query Response language (en,es,de,fr,pt,ja,hi,ar).

Why Use This Endpoint

  • Build readiness-driven training recommendations daily.
  • Detect recovery red flags before performance drop.
  • Feed auto-regulation workflows with structured decisions.

Get Started

Request Example

curl -X GET "https://api.hefitapi.com/api/v1/fitness/recovery-score?sleep_hours=7.1&resting_hr=59&hrv=66&muscle_soreness=4.2&lang=en" \
  -H "X-API-Key: YOUR_API_KEY"

curl -X POST "https://api.hefitapi.com/api/v1/fitness/recovery-score/post?lang=en" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"sleep_hours":6.3,"resting_hr":68,"hrv":44,"muscle_soreness":6.8}'

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.

{
  "readiness_score": 73,
  "readiness_band": "ready",
  "readiness_label": "Ready",
  "recovery_summary": "Training can proceed with moderate quality focus.",
  "input_signals": {"sleep_hours": 7.1, "resting_hr_bpm": 59.0, "hrv_ms": 66.0, "muscle_soreness": 4.2},
  "component_scores": {"sleep_score": 85, "resting_hr_score": 69, "hrv_score": 58, "soreness_score": 58},
  "recovery_recommendations": ["Proceed with quality session while monitoring fatigue"],
  "decision_protocol": {"today": "train", "intensity": "moderate_high"},
  "today_priority_actions": ["Warm up thoroughly", "Hydration and post-session recovery"],
  "tomorrow_readiness_focus": ["Sleep consistency", "Low-stress recovery work"],
  "red_flag_escalations": [],
  "language": "en",
  "_enterprise": {"client": "Acme Health", "plan": "pro", "request_id": "7f2552f2fb7ad884", "quota": 120, "usage_tracking": true},
  "_api_metadata_": {"endpoint_name": "fitness_recovery_score", "response_language": "en"}
}

Product Positioning

Ideal for recovery dashboards, training auto-regulation engines, and coaching platforms.

Note

muscle_soreness is required and must be in the 0-10 range.