This is a webui and API project for the kokoro TTS project, supporting voiceovers in 8 languages: Chinese, English, Japanese, French, Italian, Portuguese, Spanish, and Hindi.
Project address: https://github.com/jianchang512/kokoro-uiapi
Web Interface
The default UI address after startup is: http://127.0.0.1:5066
- Supports voiceovers for text and SRT subtitles.
- Supports online listening and downloading.
- Supports subtitle alignment.
Installation Method
Windows
For Win10/11, you can directly download the integrated package and double-click start.bat
to start it. If you need GPU acceleration, please ensure you have an NVIDIA graphics card and install CUDA12.
GitHub download address: https://github.com/jianchang512/kokoro-uiapi/releases/v0.1
Linux/MacOS
First, ensure that your system has python3.8+ installed, preferably 3.10-3.11.
On Linux, use
apt install ffmpeg
oryum install ffmpeg
to pre-install ffmpeg.On MacOS, use
brew install ffmpeg
to install ffmpeg.
- Pull the source code:
git clone https://github.com/jianchang512/kokoro-uiapi
- Create and activate a virtual environment:
cd kokoro-uiapi python3 -m venv venv . venv/bin/activate
- Install dependencies:
pip3 install -r requirements.txt
- Start:
python3 app.py
Usage in pyVideoTrans
First, start this project. For the Windows integrated package, double-click
start.bat
. For source code installation, executepython3 app.py
.Upgrade pyVideoTrans to v3.48+, open Menu -- TTS Settings - Kokoro TTS -- and fill in
http://127.0.0.1:5066
for the HTTP address.
OpenAI API Compatibility
The API is compatible with the OpenAI TTS API.
The default API address after startup is: http://127.0.0.1:5066/v1/audio/speech
Request method: POST
Request data: application/json
{
input: The text to be voiced,
voice: The voice role,
speed: Speech rate, default 1.0
}
Successful response: MP3 audio data
OpenAI SDK Usage Example
from openai import OpenAI
client = OpenAI(
api_key='123456',
base_url='http://127.0.0.1:5066/v1'
)
try:
response = client.audio.speech.create(
model='tts-1',
input='你好啊,亲爱的朋友们',
voice='zf_xiaobei',
response_format='mp3',
speed=1.0
)
with open('./test_openai.mp3', 'wb') as f:
f.write(response.content)
print("MP3 file saved successfully to test_openai.mp3")
except Exception as e:
print(f"An error occurred: {e}")
Role List
English voice roles:
af_alloy
af_aoede
af_bella
af_jessica
af_kore
af_nicole
af_nova
af_river
af_sarah
af_sky
am_adam
am_echo
am_eric
am_fenrir
am_liam
am_michael
am_onyx
am_puck
am_santa
bf_alice
bf_emma
bf_isabella
bf_lily
bm_daniel
bm_fable
bm_george
bm_lewis
Chinese roles:
zf_xiaobei
zf_xiaoni
zf_xiaoxiao
zf_xiaoyi
zm_yunjian
zm_yunxi
zm_yunxia
zm_yunyang
Japanese roles:
jf_alpha
jf_gongitsune
jf_nezumi
jf_tebukuro
jm_kumo
French roles: ff_siwis
Italian roles: if_sara,im_nicola
Hindi roles: hf_alpha,hf_beta,hm_omega,hm_psi
Spanish roles: ef_dora,em_alex,em_santa
Portuguese roles: pf_dora,pm_alex,pm_santa
Proxy VPN
For source code deployment, you need to download the voice pt files from huggingface.co, so you need to set up a global or system proxy in advance to ensure access.
Alternatively, you can download the models in advance and extract them to the directory where app.py
is located.
Model download address: https://github.com/jianchang512/kokoro-uiapi/releases/download/v0.1/moxing--jieya--dao--app.py--mulu.7z