Skip to content

Health

health

This module defines the health_router of the Mirumoji API.

Attributes:

Name Type Description
health_router APIRouter

The FastAPI Router Object

gpu_check() async

Collects information about the system running the API, including OS, GPUs, Python Version , etc

Off The Event Loop

get_system_info shells out to nvidia-smi, so it runs in a thread to avoid blocking the event loop while it waits

Returns:

Type Description
SystemInfoResponse

Information about the system running the API

health_check() async

Minimal ping endpoint to check if the API is running

Returns:

Type Description
HealthStatusResponse

UP status confirmation