API Reference
Health Endpoints
Health check and system status endpoints
Health Endpoints
Base path: /api/v1/health
Authentication is not required for health endpoints.
GET /api/v1/health
Basic health check. Returns API status and version.
Response:
{
"status": "healthy",
"version": "1.0.0",
"timestamp": "2025-01-15T10:30:00.000000"
}GET /api/v1/health/ready
Readiness check that verifies all system components.
Response:
{
"ready": true,
"components": [
{"name": "embedder", "healthy": true},
{"name": "llm", "healthy": true},
{"name": "vector_store", "healthy": true},
{"name": "reranker", "healthy": true}
],
"timestamp": "2025-01-15T10:30:00.000000"
}GET /api/v1/health/stats
System statistics including document count, sources, and model information.
Response:
{
"document_count": 1523,
"sources_count": 45,
"vector_store_path": "data/chroma_db",
"collection_name": "rag_documents",
"embedding_model": "bge-m3:latest",
"llm_model": "gemma3:latest",
"reranker_enabled": true,
"api_auth_enabled": true,
"timestamp": "2025-01-15T10:30:00.000000"
}