Skip to content

Commit 6cf640f

Browse files
authored
Create ReadMe.md
1 parent 74ffb6f commit 6cf640f

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

projects/AudioAPI/ReadMe.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Unofficial Whisper API
2+
3+
## Overview
4+
5+
Welcome to the Unofficial Whisper API documentation. This API allows you to utilize OpenAI's Whisper, a versatile speech recognition model trained on vast amounts of multilingual data, without the need for OpenAI API credits. With the Unofficial Whisper API, you can convert audio files into text transcripts with ease.
6+
7+
## Requirements
8+
9+
Before using the Unofficial Whisper API, ensure you have the following prerequisites:
10+
11+
1. **Python 3.x**: Make sure you have Python 3.x installed on your system.
12+
13+
2. **OpenAI's Whisper**: Install OpenAI's Whisper model on your system. You can find installation instructions on the [OpenAI Whisper GitHub repository](https://github.com/openai/whisper).
14+
15+
3. **Python's Flask**: Install Flask, a micro-web framework for Python, to run the API. You can install Flask using pip:
16+
17+
```bash
18+
pip install Flask
19+
20+
## Getting Started
21+
22+
1. Clone the repository
23+
2. Run transcription.py
24+
3. Open a new terminal, run this command - curl -X POST -F "audio=@C:path_to_your_audio_file" http://localhost:5000/transcribe
25+
26+
27+
## Output Formats
28+
29+
The Unofficial Whisper API provides transcription output in various formats:
30+
31+
Text: The transcribed text as a plain text string.
32+
VTT (WebVTT): Transcribed text with timestamps in the WebVTT format for easy integration with video players.
33+
SRT (SubRip): Transcribed text with timestamps in the SubRip format, suitable for subtitles.

0 commit comments

Comments
 (0)