@@ -17,6 +17,9 @@ Lightspeed Core Stack (LCS) is an AI powered assistant that provides answers to
1717* [ Usage] ( #usage )
1818 * [ Make targets] ( #make-targets )
1919 * [ Running Linux container image] ( #running-linux-container-image )
20+ * [ Endpoints] ( #endpoints )
21+ * [ Readiness Endpoint] ( #readiness-endpoint )
22+ * [ Liveness Endpoint] ( #liveness-endpoint )
2023* [ Contributing] ( #contributing )
2124* [ License] ( #license )
2225* [ Additional tools] ( #additional-tools )
@@ -89,6 +92,50 @@ To pull and run the image with own configuration:
8992
9093If a connection in your browser does not work please check that in the config file ` host ` option looks like: ` host: 0.0.0.0 ` .
9194
95+ # Endpoints
96+
97+ The service provides health check endpoints that can be used for monitoring, load balancing, and orchestration systems like Kubernetes.
98+
99+ ## Readiness Endpoint
100+
101+ ** Endpoint:** ` GET /v1/readiness `
102+
103+ The readiness endpoint checks if the service is ready to handle requests by verifying the health status of all configured LLM providers.
104+
105+ ** Response:**
106+ - ** 200 OK** : Service is ready - all providers are healthy
107+ - ** 503 Service Unavailable** : Service is not ready - one or more providers are unhealthy
108+
109+ ** Response Body:**
110+ ``` json
111+ {
112+ "ready" : true ,
113+ "reason" : " All providers are healthy" ,
114+ "providers" : []
115+ }
116+ ```
117+
118+ ** Response Fields:**
119+ - ` ready ` (boolean): Indicates if the service is ready to handle requests
120+ - ` reason ` (string): Human-readable explanation of the readiness state
121+ - ` providers ` (array): List of unhealthy providers (empty when service is ready)
122+
123+ ## Liveness Endpoint
124+
125+ ** Endpoint:** ` GET /v1/liveness `
126+
127+ The liveness endpoint performs a basic health check to verify the service is alive and responding.
128+
129+ ** Response:**
130+ - ** 200 OK** : Service is alive
131+
132+ ** Response Body:**
133+ ``` json
134+ {
135+ "alive" : true
136+ }
137+ ```
138+
92139# Contributing
93140
94141* See [ contributors] ( CONTRIBUTING.md ) guide.
0 commit comments