tianyaogavin commited on
Commit
fe90877
·
1 Parent(s): c967100

readme hugging face

Browse files
Files changed (1) hide show
  1. README.md +16 -6
README.md CHANGED
@@ -1,13 +1,23 @@
1
- # Whisper Transcription API on Hugging Face Spaces
 
 
 
 
 
 
 
 
2
 
3
- This Space provides a simple REST API to transcribe audio using faster-whisper.
4
 
5
- ### Endpoints
6
 
7
- - `GET /` → health check
8
- - `POST /transcribe` → Transcribe audio file (wav/mp3/etc.)
9
 
10
- ### Example Usage (curl)
 
 
 
11
 
12
  ```bash
13
  curl -X POST https://your-space-name.hf.space/transcribe \
 
1
+ ---
2
+ title: Whisper API Server
3
+ emoji: 🎙️
4
+ colorFrom: indigo
5
+ colorTo: pink
6
+ sdk: docker
7
+ app_file: app.py
8
+ pinned: false
9
+ ---
10
 
11
+ # Whisper API Server with faster-whisper
12
 
13
+ This Space provides a REST API to transcribe audio using faster-whisper + FastAPI.
14
 
15
+ ## API Endpoints
 
16
 
17
+ - `GET /` → Health check
18
+ - `POST /transcribe` → Upload a `.wav/.mp3` file and receive transcript text
19
+
20
+ ## Example usage (cURL)
21
 
22
  ```bash
23
  curl -X POST https://your-space-name.hf.space/transcribe \