Commit
Β·
3f8cddc
1
Parent(s):
50ec2c4
Update README with API documentation reference
Browse files
README.md
CHANGED
|
@@ -58,12 +58,37 @@ This MVP demonstrates an intelligent research assistant framework featuring **tr
|
|
| 58 |
- **π± Mobile-First**: Optimized for seamless mobile web experience
|
| 59 |
- **π Academic Focus**: Designed for research and educational use cases
|
| 60 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 61 |
## π Quick Start
|
| 62 |
|
| 63 |
### Option 1: Use Our Demo
|
| 64 |
Visit our live demo on Hugging Face Spaces:
|
| 65 |
```bash
|
| 66 |
-
https://huggingface.co/spaces/
|
| 67 |
```
|
| 68 |
|
| 69 |
### Option 2: Deploy Your Own Instance
|
|
|
|
| 58 |
- **π± Mobile-First**: Optimized for seamless mobile web experience
|
| 59 |
- **π Academic Focus**: Designed for research and educational use cases
|
| 60 |
|
| 61 |
+
## π API Documentation
|
| 62 |
+
|
| 63 |
+
**Comprehensive API documentation is available:** [API_DOCUMENTATION.md](API_DOCUMENTATION.md)
|
| 64 |
+
|
| 65 |
+
The API provides REST endpoints for:
|
| 66 |
+
- Chat interactions with AI assistant
|
| 67 |
+
- Health checks
|
| 68 |
+
- Context management
|
| 69 |
+
- Session tracking
|
| 70 |
+
|
| 71 |
+
**Quick API Example:**
|
| 72 |
+
```python
|
| 73 |
+
import requests
|
| 74 |
+
|
| 75 |
+
response = requests.post(
|
| 76 |
+
"https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assistant_API/api/chat",
|
| 77 |
+
json={
|
| 78 |
+
"message": "What is machine learning?",
|
| 79 |
+
"session_id": "my-session",
|
| 80 |
+
"user_id": "user-123"
|
| 81 |
+
}
|
| 82 |
+
)
|
| 83 |
+
print(response.json()["message"])
|
| 84 |
+
```
|
| 85 |
+
|
| 86 |
## π Quick Start
|
| 87 |
|
| 88 |
### Option 1: Use Our Demo
|
| 89 |
Visit our live demo on Hugging Face Spaces:
|
| 90 |
```bash
|
| 91 |
+
https://huggingface.co/spaces/JatinAutonomousLabs/Research_AI_Assistant_API
|
| 92 |
```
|
| 93 |
|
| 94 |
### Option 2: Deploy Your Own Instance
|