Update README.md

README.md

@@ -6,70 +6,128 @@ emoji: 😻
 colorFrom: purple
 colorTo: green
 short_description: Detect AI-generated music vs human-created music using advan
+sdk_version: 1.46.1
 ---
-title: AI Music Detection
-emoji: 🎵
-colorFrom: blue
-colorTo: purple
-sdk: streamlit
-sdk_version: "1.28.1"
-app_file: app.py
-pinned: false
 
-# Madverse Music: AI Music Detection
+# Madverse Music: AI Music Detection API
 
-Detect AI-generated music vs human-created music using advanced AI technology.
+AI-powered REST API to detect AI-generated music vs human-created music using advanced transformer technology.
 
 ## What is Madverse Music?
 
-Madverse Music is an AI-powered tool that can detect whether music is created by AI or human artists. With the growth of AI music generation platforms like Suno and Udio, it's important to distinguish between human creativity and artificial intelligence.
+Madverse Music is an AI-powered REST API that can detect whether music is created by AI or human artists. With the growth of AI music generation platforms like Suno and Udio, it's important to distinguish between human creativity and artificial intelligence.
 
 ## Key Features
 
-- Upload and analyze audio files instantly
-- Web interface for easy testing
-- REST API for integration
+- REST API for seamless integration
 - High accuracy: 97% F1 score with 96% sensitivity and 99% specificity
-- Supports WAV, MP3, FLAC, M4A, and OGG files
+- Supports WAV, MP3, FLAC, M4A, and OGG files via URL
 - Uses SpecTTTra transformer technology
 - Trained on 97,000+ songs
+- Concurrent processing for multiple files
+- Built with FastAPI for automatic documentation
 
 ## Quick Start
 
-### Hugging Face Space (Recommended)
-1. Go to our Hugging Face Space
-2. Upload your audio file
-3. Get instant results
+### Installation
 
-### Local Setup
 ```bash
 # Install dependencies
 pip install -r requirements.txt
 
-# Start web interface
-streamlit run app.py
+# Start the API server
+python app.py
+```
+
+The API will be available at `http://localhost:8000` with automatic documentation.
+
+## API Endpoints
+
+### Health Check
+```bash
+GET /health
+```
+
+### Get API Information
+```bash
+GET /info
+```
+
+### Analyze Music
+```bash
+POST /analyze
+```
 
-# Or start API server
-python api.py
-```  
+## Authentication
 
-## Web Interface
+All API requests require an API key in the header:
 
-Use the web interface for easy testing:
+```bash
+X-API-Key: madverse-music-api-key-2024
+```
+
+## Usage Examples
 
+### Single File Analysis
 ```bash
-streamlit run app.py
+curl -X POST "http://localhost:8000/analyze" \
+     -H "X-API-Key: madverse-music-api-key-2024" \
+     -H "Content-Type: application/json" \
+     -d '{"urls": ["https://example.com/song.mp3"]}'
 ```
 
-Then open your browser to `http://localhost:8501` and:
-1. Upload your audio file
-2. Click "Analyze Audio"  
-3. Get instant results
+### Multiple Files Analysis
+```bash
+curl -X POST "http://localhost:8000/analyze" \
+     -H "X-API-Key: madverse-music-api-key-2024" \
+     -H "Content-Type: application/json" \
+     -d '{"urls": ["https://example.com/song1.mp3", "https://example.com/song2.wav"]}'
+```
 
-The web interface provides:
-- Audio player to preview your file
-- Detailed analysis with confidence scores
-- Clean visualization of results
+### Python Example
+```python
+import requests
+
+headers = {
+    'X-API-Key': 'madverse-music-api-key-2024',
+    'Content-Type': 'application/json'
+}
+
+data = {
+    'urls': ['https://example.com/your-song.mp3']
+}
+
+response = requests.post('http://localhost:8000/analyze', 
+                        headers=headers, json=data)
+result = response.json()
+print(result)
+```
+
+## Response Format
+
+```json
+{
+  "success": true,
+  "total_files": 1,
+  "successful_analyses": 1,
+  "failed_analyses": 0,
+  "results": [
+    {
+      "url": "https://example.com/song.mp3",
+      "success": true,
+      "classification": "Real",
+      "confidence": 0.85,
+      "probability": 0.15,
+      "raw_score": -1.73,
+      "duration": 30.5,
+      "message": "🎤 Detected as real music",
+      "processing_time": 2.34
+    }
+  ],
+  "total_processing_time": 2.45,
+  "message": "🎤 Detected as real music"
+}
+```
 
 ## Model Performance
 
@@ -83,41 +141,50 @@ Our model (SpecTTTra-α 120s) achieves:
 - Model: SpecTTTra (Spectro-Temporal Tokens Transformer)
 - Sample Rate: 16kHz
 - Max Duration: 120 seconds
-- Trained on 97,000+ songs  
+- Max File Size: 100MB per file
+- Max Files per Request: 50
+- Concurrent Processing: Up to 5 files simultaneously
 
-## API Usage
+## API Documentation
 
-### Hugging Face Space
-```bash
-# Health check
-curl https://your-space-name.hf.space/health
+When the server is running, visit `http://localhost:8000` for interactive API documentation (Swagger UI) or `http://localhost:8000/docs` for ReDoc format.
 
-# Analyze audio file
-curl -X POST "https://your-space-name.hf.space/analyze" \
-     -F "[email protected]"
-```
+## Supported Formats
 
-### Local Setup
-```bash
-# Install dependencies
-pip install -r requirements.txt
+- MP3 (.mp3)
+- WAV (.wav)
+- FLAC (.flac)
+- M4A (.m4a)
+- OGG (.ogg)
 
-# Start the API server
-python api.py
-```
+## Rate Limits
 
-### Command Line Usage
+- Maximum 50 URLs per request
+- Maximum 100MB per file
+- 5 concurrent downloads per request
 
-```bash
-# Analyze a single file
-python classify_audio.py "your_song.mp3"
+## Error Handling
+
+The API provides detailed error messages for:
+- Invalid API keys (401)
+- File too large (413)
+- Unsupported formats (400)
+- Network errors (400)
+- Processing errors (500)
 
-# Analyze all files in directory
-python classify_audio.py
+## Environment Variables
+
+- `MADVERSE_API_KEY`: Set custom API key (default: "madverse-music-api-key-2024")
+
+## Testing
+
+```bash
+# Run API tests
+python test_api.py
 ```
 
 ## Acknowledgments
 
-This tool is designed for research, education, and transparency in AI music detection. Results may vary depending on audio quality and content type.
+This API is designed for research, education, and transparency in AI music detection. Results may vary depending on audio quality and content type.
 
-Visit [madverse.co](https://madverse.co) for more information.
+Visit [madverse.co](https://madverse.co) for more information.