waliullah123 commited on
Commit
ef6ab98
·
verified ·
1 Parent(s): 1048608

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +29 -7
README.md CHANGED
@@ -1,13 +1,35 @@
1
  ---
2
- title: Truth Detector Api
3
- emoji:
4
- colorFrom: red
5
- colorTo: gray
6
  sdk: gradio
7
- sdk_version: 6.24.0
8
- python_version: '3.12'
9
  app_file: app.py
10
  pinned: false
 
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Truth Detector API
3
+ emoji: 🔍
4
+ colorFrom: indigo
5
+ colorTo: purple
6
  sdk: gradio
7
+ sdk_version: 4.44.0
 
8
  app_file: app.py
9
  pinned: false
10
+ license: mit
11
  ---
12
 
13
+ # Truth Detector API
14
+
15
+ Backend API for Fake News Detection — served via Flask + Gunicorn on a Docker Space.
16
+
17
+ ## REST API Endpoints
18
+
19
+ | Method | Route | Description |
20
+ |--------|-------|-------------|
21
+ | GET | `/api/health` | Health check |
22
+ | POST | `/api/register` | Register a new user |
23
+ | POST | `/api/login` | Login and get JWT token |
24
+ | POST | `/api/predict` | Run fake news prediction |
25
+ | GET | `/api/metrics` | List available models and metrics |
26
+ | POST | `/api/recommend-model` | Get recommended model for input text |
27
+ | POST | `/api/verify` | External Google Fact Check API lookup |
28
+
29
+ ## Environment Variables (Space Secrets)
30
+
31
+ | Variable | Description |
32
+ |----------|-------------|
33
+ | `DATABASE_URL` | Neon PostgreSQL connection URI |
34
+ | `TRUTH_SECRET_KEY` | JWT signing secret |
35
+ | `FRONTEND_ORIGIN` | Allowed CORS origin (Vercel URL) |