Update README.md
Browse files
README.md
CHANGED
|
@@ -1,12 +1,27 @@
|
|
| 1 |
---
|
| 2 |
-
title:
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
-
sdk:
|
| 7 |
-
sdk_version: 6.3.0
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
---
|
| 11 |
|
| 12 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: StudyLoop API
|
| 3 |
+
emoji: 📚
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: purple
|
| 6 |
+
sdk: docker
|
|
|
|
| 7 |
app_file: app.py
|
| 8 |
pinned: false
|
| 9 |
---
|
| 10 |
|
| 11 |
+
# StudyLoop API
|
| 12 |
+
|
| 13 |
+
AI-powered API for generating practice questions from study materials.
|
| 14 |
+
|
| 15 |
+
## Quick Test
|
| 16 |
+
Test the API is working: https://andevs-studyloop.hf.space/health
|
| 17 |
+
|
| 18 |
+
## API Endpoints
|
| 19 |
+
|
| 20 |
+
### `POST /api/generate`
|
| 21 |
+
Generate questions from text.
|
| 22 |
+
|
| 23 |
+
**Example:**
|
| 24 |
+
```bash
|
| 25 |
+
curl -X POST https://andevs-studyloop.hf.space/api/generate \
|
| 26 |
+
-F "session_id=test123" \
|
| 27 |
+
-F "text=Study material here"
|