Fix API documentation URLs: use correct HF Spaces .hf.space domain format and add troubleshooting section

API_DOCUMENTATION.md

@@ -4,12 +4,16 @@
 
 The Research AI Assistant API provides a RESTful interface for interacting with an AI-powered research assistant. The API uses local GPU models for inference and supports conversational interactions with context management.
 
-**Base URL:** `https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assistant_API`
+**Base URL (HF Spaces):** `https://jatinautonomouslabs-research-ai-assistant-api.hf.space`
+
+**Alternative Base URL:** `https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assistant_API`
 
 **API Version:** 1.0
 
 **Content-Type:** `application/json`
 
+> **Note:** For Hugging Face Spaces Docker deployments, use the `.hf.space` domain format. The space name is converted to lowercase with hyphens.
+
 ## Features
 
 - 🤖 **AI-Powered Responses** - Local GPU model inference (Tesla T4)
@@ -232,7 +236,7 @@ Content-Type: application/json
 import requests
 import json
 
-BASE_URL = "https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assistant_API"
+BASE_URL = "https://jatinautonomouslabs-research-ai-assistant-api.hf.space"
 
 # Check health
 def check_health():
@@ -290,7 +294,7 @@ if __name__ == "__main__":
 ### JavaScript (Fetch API)
 
 ```javascript
-const BASE_URL = 'https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assistant_API';
+const BASE_URL = 'https://jatinautonomouslabs-research-ai-assistant-api.hf.space';
 
 // Check health
 async function checkHealth() {
@@ -362,10 +366,10 @@ main();
 
 ```bash
 # Check health
-curl -X GET "https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assistant_API/api/health"
+curl -X GET "https://jatinautonomouslabs-research-ai-assistant-api.hf.space/api/health"
 
 # Send chat message
-curl -X POST "https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assistant_API/api/chat" \
+curl -X POST "https://jatinautonomouslabs-research-ai-assistant-api.hf.space/api/chat" \
   -H "Content-Type: application/json" \
   -d '{
     "message": "What is machine learning?",
@@ -375,7 +379,7 @@ curl -X POST "https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assi
   }'
 
 # Continue conversation
-curl -X POST "https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assistant_API/api/chat" \
+curl -X POST "https://jatinautonomouslabs-research-ai-assistant-api.hf.space/api/chat" \
   -H "Content-Type: application/json" \
   -d '{
     "message": "Can you explain neural networks?",
@@ -392,7 +396,7 @@ curl -X POST "https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assi
 ```javascript
 const axios = require('axios');
 
-const BASE_URL = 'https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assistant_API';
+const BASE_URL = 'https://jatinautonomouslabs-research-ai-assistant-api.hf.space';
 
 // Check health
 async function checkHealth() {
@@ -607,7 +611,7 @@ const AIAssistant = () => {
         
         setLoading(true);
         try {
-            const response = await fetch('https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assistant_API/api/chat', {
+            const response = await fetch('https://jatinautonomouslabs-research-ai-assistant-api.hf.space/api/chat', {
                 method: 'POST',
                 headers: { 'Content-Type': 'application/json' },
                 body: JSON.stringify({
@@ -661,7 +665,7 @@ const AIAssistant = () => {
 import requests
 import sys
 
-BASE_URL = "https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assistant_API"
+BASE_URL = "https://jatinautonomouslabs-research-ai-assistant-api.hf.space"
 
 class ChatCLI:
     def __init__(self):
@@ -720,6 +724,84 @@ if __name__ == "__main__":
 
 ---
 
+## Troubleshooting
+
+### Common Issues
+
+#### 404 Not Found
+
+**Problem:** Getting 404 when accessing the API
+
+**Solutions:**
+1. **Verify the Space is running:**
+   - Check the Hugging Face Space page to ensure it's built and running
+   - Wait for the initial build to complete (5-10 minutes)
+
+2. **Check URL format:**
+   - ✅ Correct: `https://jatinautonomouslabs-research-ai-assistant-api.hf.space`
+   - ❌ Wrong: `https://jatinautonomouslabs-research_ai_assistant_api.hf.space` (underscores)
+   - ✅ Alternative: `https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assistant_API`
+
+3. **Verify endpoint paths:**
+   - Health: `GET /api/health`
+   - Chat: `POST /api/chat`
+   - Root: `GET /`
+
+4. **Test with root endpoint first:**
+   ```bash
+   curl https://jatinautonomouslabs-research-ai-assistant-api.hf.space/
+   ```
+
+#### 503 Service Unavailable
+
+**Problem:** Orchestrator not ready
+
+**Solutions:**
+1. Wait 30-60 seconds for initialization
+2. Check `/api/health` endpoint
+3. Use `/api/initialize` to manually trigger initialization
+
+#### CORS Errors
+
+**Problem:** CORS errors in browser
+
+**Solutions:**
+- The API has CORS enabled for all origins
+- If issues persist, check browser console for specific errors
+- Ensure you're using the correct base URL
+
+### Testing API Connectivity
+
+**Quick Health Check:**
+```bash
+# Test root endpoint
+curl https://jatinautonomouslabs-research-ai-assistant-api.hf.space/
+
+# Test health endpoint
+curl https://jatinautonomouslabs-research-ai-assistant-api.hf.space/api/health
+```
+
+**Python Test Script:**
+```python
+import requests
+
+BASE_URL = "https://jatinautonomouslabs-research-ai-assistant-api.hf.space"
+
+# Test root
+try:
+    response = requests.get(f"{BASE_URL}/", timeout=10)
+    print(f"Root endpoint: {response.status_code} - {response.json()}")
+except Exception as e:
+    print(f"Root endpoint failed: {e}")
+
+# Test health
+try:
+    response = requests.get(f"{BASE_URL}/api/health", timeout=10)
+    print(f"Health endpoint: {response.status_code} - {response.json()}")
+except Exception as e:
+    print(f"Health endpoint failed: {e}")
+```
+
 ## Support
 
 For issues, questions, or contributions: