From e8a4c814afcd8b333fc1dae86387fd274c1f8a0a Mon Sep 17 00:00:00 2001
From: ngxson <thichthat@gmail.com>
Date: Sat, 9 Mar 2024 21:22:49 +0100
Subject: [PATCH] update docs

---
 examples/server/README.md | 46 +++++++++++++++++++++++++++++++++++++--
 1 file changed, 44 insertions(+), 2 deletions(-)

diff --git a/examples/server/README.md b/examples/server/README.md
index 23606b32a..02eafcad8 100644
--- a/examples/server/README.md
+++ b/examples/server/README.md
@@ -556,9 +556,51 @@ Run with bash:
 bash chat.sh
 ```
 
-### API like OAI
+### API like OpenAI
 
-The HTTP server supports OAI-like API
+The HTTP server supports OpenAI-like API
+
+### API errors
+
+Server returns error in the same format as OpenAI API: https://platform.openai.com/docs/guides/error-codes/api-errors
+
+Example of an error:
+
+```json
+{
+    "error": {
+        "code": 401,
+        "message": "Invalid API Key",
+        "type": "authentication_error"
+    }
+}
+```
+
+Apart from error types supported by OpenAI, we also have custom types that are specific to functionalities of llama.cpp:
+
+**When /metrics or /slots endpoint is disabled**
+
+```json
+{
+    "error": {
+        "code": 501,
+        "message": "This server does not support metrics endpoint.",
+        "type": "not_supported_error"
+    }
+}
+```
+
+**When the server receives invalid grammar via */completions endpoint**
+
+```json
+{
+    "error": {
+        "code": 400,
+        "message": "Failed to parse grammar",
+        "type": "invalid_request_error"
+    }
+}
+```
 
 ### Extending or building alternative Web Front End