diff options
| -rw-r--r-- | examples/server/README.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/examples/server/README.md b/examples/server/README.md index d85a14f8..dc27e72b 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. |