From b1a99c826d36b0f5a5f35d17036b4ff9e1b710b2 Mon Sep 17 00:00:00 2001
From: Ashley <tuyethantt@gmail.com>
Date: Wed, 15 Jan 2025 22:45:10 +0700
Subject: [PATCH] Updated api server docs

---
 docs/src/pages/docs/_meta.json     |   1 +
 docs/src/pages/docs/api-server.mdx | 111 +++++++++++++++++++++++++++++
 2 files changed, 112 insertions(+)
 create mode 100644 docs/src/pages/docs/api-server.mdx

diff --git a/docs/src/pages/docs/_meta.json b/docs/src/pages/docs/_meta.json
index bdd9be159..b395ff7af 100644
--- a/docs/src/pages/docs/_meta.json
+++ b/docs/src/pages/docs/_meta.json
@@ -23,6 +23,7 @@
   "assistants": "Assistants",
   "threads": "Threads",
   "settings": "Settings",
+  "api-server": "Local API Server",
   "inference-engines": {
     "title": "ENGINES",
     "type": "separator"
diff --git a/docs/src/pages/docs/api-server.mdx b/docs/src/pages/docs/api-server.mdx
new file mode 100644
index 000000000..74385e8e7
--- /dev/null
+++ b/docs/src/pages/docs/api-server.mdx
@@ -0,0 +1,111 @@
+---
+title: Local API Server
+description: Learn how to run Jan's local API server.
+  [
+    Jan,
+    Customizable Intelligence, LLM,
+    local AI,
+    privacy focus,
+    free and open source,
+    private and offline,
+    conversational AI,
+    no-subscription fee,
+    large language models,
+    Jan Extensions,
+    Extensions,
+  ]
+---
+
+import { Callout, Steps } from 'nextra/components'
+import { Settings, EllipsisVertical } from 'lucide-react'
+
+# Local API Server
+
+Jan includes a built-in API server that is compatible with OpenAI's API specification, allowing you to interact with AI models through a local HTTP interface. This means you can use Jan as a drop-in replacement for OpenAI's API, but running entirely on your computer.
+
+
+<Callout>
+Full API documentation is available at [Cortex's API Reference](https://cortex.so/api-reference#tag/chat).
+</Callout>
+
+## Start Server
+
+<Steps>
+
+### Step 1: Start Server
+1. Navigate to the **Local API Server**
+2. Configure [Server Settings](/docs/api-server#server-settings)
+3. Click **Start Server** button
+4. Wait for the confirmation message in the logs panel, your server is ready when you see: `JAN API listening at: http://127.0.0.1:1337`
+
+
+### Step 2: Test Server
+The easiest way to test your server is through the API Playground:
+1. Click the **API Playground** button to open its testing interface
+2. Select a model from the dropdown menu in Jan interface
+3. Try a simple [chat completion](https://cortex.so/api-reference#tag/chat/post/v1/chat/completions) request
+4. View the response in real-time
+
+### Step 3: Use the API 
+Navigate to [Cortex's API Reference](https://cortex.so/api-reference#tag/chat) to see full API endpoints for your use case.
+</Steps>
+
+
+## Server Settings
+
+#### Host Address Options
+- **127.0.0.1 (Recommended)**: 
+  - Only accessible from your computer
+  - Most secure option for personal use
+- **0.0.0.0**: 
+  - Makes server accessible from other devices on your network
+  - Use with caution and only when necessary
+
+#### Port Number
+- Default: `1337`
+- Can be any number between 1-65535
+- Avoid common ports (80, 443, 3000, 8080) that might be used by other applications
+
+#### API Prefix
+- Default: `/v1`
+- Defines the base path for all API endpoints
+- Example: http://127.0.0.1:1337/v1/chat/completions
+
+#### Cross-Origin Resource Sharing (CORS)
+CORS controls which websites can access your API, which is important for web applications running in browsers.
+
+**When to enable:**
+- If you're building a web application that needs to access the API
+- If you're using browser extensions
+
+**When to leave disabled:**
+- If you're only using the API from your local applications
+- If you're concerned about security
+
+#### Verbose Server Logs
+Enable to show:
+- Detailed information about each API request
+- Error messages and debugging information
+- Server status updates
+
+## Troubleshooting Guide
+
+1. Server Won't Start
+   - Check if the port is already in use
+   - Verify you have admin/sudo rights if needed
+   - Look for error messages in the logs
+
+2. Connection Refused
+   - Confirm the server is running
+   - Check if the host/port combination is correct
+   - Verify firewall settings
+
+3. CORS Errors
+   - Enable CORS if making browser requests
+   - Verify the origin of the request
+   - Check browser console for specific error messages
+
+4. Performance Issues
+   - Monitor system resources (CPU, RAM, and GPU usage)
+   - Try to reduce the context length or `ngl` (number of GPU layers)
+   - Check for other resource-intensive applications