Update README.md
Browse files
README.md
CHANGED
|
@@ -1,38 +1,33 @@
|
|
| 1 |
---
|
| 2 |
-
title: StudyLoop
|
| 3 |
emoji: π
|
| 4 |
colorFrom: blue
|
| 5 |
colorTo: purple
|
| 6 |
sdk: docker
|
| 7 |
-
sdk_version: "3.0"
|
| 8 |
-
python_version: "3.11"
|
| 9 |
-
app_file: app.py
|
| 10 |
pinned: false
|
| 11 |
---
|
| 12 |
|
| 13 |
-
# StudyLoop
|
| 14 |
|
| 15 |
-
|
| 16 |
|
| 17 |
-
##
|
| 18 |
|
| 19 |
-
-
|
| 20 |
-
-
|
| 21 |
-
-
|
| 22 |
-
-
|
| 23 |
-
- **π‘οΈ Safe & Secure**: Content validation and rate limiting
|
| 24 |
|
| 25 |
-
##
|
| 26 |
|
| 27 |
-
|
|
|
|
| 28 |
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
-F "session_id=test123" \
|
| 38 |
-
-F "options={\"num_questions\": 5}"
|
|
|
|
| 1 |
---
|
| 2 |
+
title: StudyLoop
|
| 3 |
emoji: π
|
| 4 |
colorFrom: blue
|
| 5 |
colorTo: purple
|
| 6 |
sdk: docker
|
|
|
|
|
|
|
|
|
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
+
# StudyLoop API
|
| 11 |
|
| 12 |
+
Generate practice questions from study materials.
|
| 13 |
|
| 14 |
+
## API Endpoints
|
| 15 |
|
| 16 |
+
- `GET /` - Welcome message
|
| 17 |
+
- `GET /health` - Health check
|
| 18 |
+
- `POST /api/generate` - Generate questions from text
|
| 19 |
+
- `POST /api/generate-more` - Generate additional questions
|
|
|
|
| 20 |
|
| 21 |
+
## Usage
|
| 22 |
|
| 23 |
+
```python
|
| 24 |
+
import requests
|
| 25 |
|
| 26 |
+
response = requests.post(
|
| 27 |
+
"https://your-space.hf.space/api/generate",
|
| 28 |
+
data={
|
| 29 |
+
"text": "Your study material here...",
|
| 30 |
+
"session_id": "test_session",
|
| 31 |
+
"options": '{"num_questions": 5}'
|
| 32 |
+
}
|
| 33 |
+
)
|
|
|
|
|
|