Skip to main content

Health

GET 

/v1/health

Perform a system health check.

  • Returns: Current system health status and uptime

Health Check Details

  • Provides a quick verification of system operational status
  • Reports current system uptime

Status Indicators

  • status: Indicates system operational condition
    • "ok": System is functioning normally
  • uptime: Duration the system has been running

Example

# Retrieve system health status
health = await health_check()
# Expect: HealthCheckResponse(status='ok', uptime=3600)

Responses

Successful Response