Skip to content

Sleep Optimizer API

Generate sleep-quality diagnostics and practical optimization protocol for nightly recovery improvement.

Endpoint

  • GET /api/v1/fitness/sleep-optimizer
  • POST /api/v1/fitness/sleep-optimizer/post

Parameters

Name Type Required In Description
sleep_hours number (0-16) Yes Query/Body Total sleep duration.
sleep_consistency_score integer (0-100) Yes Query/Body Sleep schedule consistency.
caffeine_intake_mg number (0-1200) Yes Query/Body Daily caffeine intake in mg.
screen_time_before_bed number (0-360) Yes Query/Body Screen exposure minutes before sleep.
lang string No Query Response language (en,es,de,fr,pt,ja,hi,ar).

Why Use This Endpoint

  • Quantify sleep and circadian quality in one model output.
  • Get targeted optimization steps for fast behavior iteration.
  • Improve recovery and training outcomes through sleep interventions.

Get Started

Request Example

curl -X GET "https://api.hefitapi.com/api/v1/fitness/sleep-optimizer?sleep_hours=6.9&sleep_consistency_score=62&caffeine_intake_mg=260&screen_time_before_bed=75&lang=en" \
  -H "X-API-Key: YOUR_API_KEY"

curl -X POST "https://api.hefitapi.com/api/v1/fitness/sleep-optimizer/post?lang=en" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"sleep_hours":7.8,"sleep_consistency_score":84,"caffeine_intake_mg":120,"screen_time_before_bed":20}'

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.

{
  "sleep_hours": 6.9,
  "sleep_consistency_score": 62,
  "caffeine_intake_mg": 260.0,
  "screen_time_before_bed_minutes": 75.0,
  "sleep_quality_score": 55,
  "sleep_quality_band": {"band": "fragile", "band_label": "Fragile"},
  "circadian_alignment_insight": {"score": 58, "status": "misaligned", "status_label": "Misaligned", "insight": "Current schedule and habits reduce circadian stability."},
  "optimization_protocol": ["Reduce late caffeine and screen exposure", "Anchor wake time consistency"],
  "recovery_priority": "Stabilize routine before increasing training stress.",
  "next_adjustment_window_days": 3,
  "confidence_score": 77,
  "summary": "Sleep profile is fragile; near-term routine correction advised.",
  "language": "en",
  "_enterprise": {"client": "Acme Health", "plan": "pro", "request_id": "56e5dbbb8de53ceb", "quota": 120, "usage_tracking": true},
  "_api_metadata_": {"endpoint_name": "fitness_sleep_optimizer", "response_language": "en"}
}

Product Positioning

Premium feature for recovery apps, performance coaching, and wellness behavior platforms.

Note

screen_time_before_bed is measured in minutes.