From 2196fa64c419e30521690a78bc0e3a45fe27fb5e Mon Sep 17 00:00:00 2001
From: Behnam M <58621210+ibehnam@users.noreply.github.com>
Date: Wed, 10 Jan 2024 19:50:58 -0500
Subject: [PATCH] updated `server` readme to document the `/health` endpoint
 too

---
 examples/server/README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/examples/server/README.md b/examples/server/README.md
index d85a14f89..dc27e72b9 100644
--- a/examples/server/README.md
+++ b/examples/server/README.md
@@ -110,6 +110,10 @@ node index.js
 ```
 
 ## API Endpoints
+- **GET** `/health`: Returns the current state of the server:
+    - `{"status": "loading model"}` if the model is still being loaded.
+    - `{"status": "error"}` if the model failed to load.
+    - `{"status": "ok"}` if the model is successfully loaded and the server is ready for further requests mentioned below.
 
 -   **POST** `/completion`: Given a `prompt`, it returns the predicted completion.