andevs commited on
Commit
8ef5915
Β·
verified Β·
1 Parent(s): d344fc1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +19 -24
README.md CHANGED
@@ -1,38 +1,33 @@
1
  ---
2
- title: StudyLoop AI
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 AI Backend
14
 
15
- πŸš€ **Intelligent study question generator powered by Hugging Face AI**
16
 
17
- ## πŸ“‹ Features
18
 
19
- - **πŸ€– AI-Powered Questions**: Generate multiple choice, short answer, true/false questions
20
- - **🎯 Smart Content Analysis**: Extracts key concepts and learning objectives
21
- - **⚑ Fast & Reliable**: Optimized for Hugging Face Spaces with intelligent fallbacks
22
- - **πŸ“Š Smart Caching**: Reduces API calls and improves response times
23
- - **πŸ›‘οΈ Safe & Secure**: Content validation and rate limiting
24
 
25
- ## πŸš€ Quick Start
26
 
27
- Your API is live at: **`https://andevs-studyloop.hf.space`**
 
28
 
29
- ### Test the API:
30
- ```bash
31
- # Health check
32
- curl https://andevs-studyloop.hf.space/health
33
-
34
- # Generate questions
35
- curl -X POST https://andevs-studyloop.hf.space/api/generate \
36
- -F "text=Photosynthesis is the process plants use to convert sunlight into chemical energy." \
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
+ )