[POST] Text to speech

https://www.everai.vn/api/v1/tts

Cấu trúc TTS API gửi request lên server như sau:

HTTP Request

URL: https://www.everai.vn/api/v1/tts Method: POST Content Type: application/json Response Type: text/json

Tham số header

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
Authorization	Bearer Token		API key của người dùng, được tạo trong giao diện tại https://everai.vn/api

Cấu trúc body của request

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
response_type	String		indirect
callback_url	String		Đường dẫn Webhook để nhận kết quả của request
input_text	String		Văn bản đầu vào cần tổng hợp
voice_code	String		Mã giọng đọc cần tổng hợp
audio_type	String		Định dạng loại file audio đầu ra * Giá trị mặc định: mp3 * Giá trị audio_type cho phép truyền vào là: mp3, wav
bitrate	Number		Dùng để chuyển đầu ra về bit rate (bps) mong muốn * Giá trị mặc định: 128 * Giá trị bit_rate cho phép truyền vào là: 8, 16, 32, 64, 128, 160 * Lưu ý: giá trị tham số bit_rate chỉ có ý nghĩa khi audio_type=mp3
speed_rate	Number		Dùng để điều chỉnh tốc độ của giọng đọc * Giá trị mặc định: 1.0 * Giá trị của tham số speed_rate có thể chạy từ 0.5 đến 2.0 và chấp nhận 1 chứ số sau dấu thập phân
pitch_rate	Number		Dùng để điều chỉnh độ của giọng đọc * Giá trị mặc định: 1.0 * Giá trị của tham số pitch_rate có thể chạy từ 0.5 đến 2.0 và chấp nhận 1 chữ số sau dấu thập phân
volume	Number		Dùng để điều chỉnh độ to của giọng nói * Giá trị mặc định: 100 * Giá trị của tham số volume có thể chạy từ 50 đến 150 và chấp nhận số nguyên

Kết quả trả về

• status: trạng thái của API (1: thành công, 0: thất bại)

• error_code: mã lỗi (Nếu có)

• error_message: chi tiết lỗi (Nếu có)

• result: dữ liệu trả về khi gọi API thành công

  • request_id: mã request

  • characters: số ký tự của đoạn văn bản convert

  • voice_code

  • audio_type

  • speed_rate

  • pitch_rate

  • bitrate

  • create_at

  • status: trạng thái của request

Danh sách mã giọng đọc

Để lấy giá trị voice_code của các giọng đọc, bạn hãy truy cập vào trang danh sách giọng đọc tại đây.

Để copy mã giọng đọc (voice_code) vào clipboard, hãy bấm vào button "ID" phía bên phải tên mỗi giọng đọc.

Danh sách mã giọng đọc có sẵn trên hệ thống

Ngôn ngữ	Mã giọng	Tên	Giới tính	Giá / 1000 ký tự
Việt Nam	vi_female_kieunhi_mn	Kiều Nhi	Nữ - Miền Nam	1000 credits
Việt Nam	vi_female_huyenanh_mb	Huyền Anh	Nữ - Miền Bắc	1000 credits
Việt Nam	vi_female_hacuc_mb	Hạ Cúc	Nữ - Miền Bắc	1000 credits
Việt Nam	vi_female_halinh_mb	Hà Linh	Nữ - Miền Bắc	1000 credits
Việt Nam	vi_male_echo_default	Echo	Nam - Giọng Mỹ	100 credits
Việt Nam	vi_female_nova_default	Nova	Nữ - Giọng Mỹ	100 credits
Việt Nam	vi_male_onyx_default	Onyx	Nam - Giọng Mỹ	100 credits
English	en_male_echo_default	Echo	Male - American	100 credits
English	en_female_nova_default	Nova	Female - American	100 credits
English	en_male_onyx_default	Echo	Male - American	100 credits
English	en_female_emily_us	Emily	Female - American	1000 credits
English	en_female_alice_default	Alice	Female - American	1000 credits
English	en_female_jessica_au	Jessica	Female - Australian	1000 credits
English	en_female_elara_br	Elara	Female - British	1000 credits
English	en_female_meera_indian	Meera	Female - Indian	1000 credits
Chinese	zh_female_liu-ying_default	Liu Ying	Female - Chinese	1000 credits
Japanese	jp_female_yuki_default	Yuki	Female - Japanese	1000 credits
Korean	kr_female_seo-yeon_default	Seo Yeon	Female - Korean	1000 credits
French	fr_female_camille_default	Camille	Female - French	1000 credits
Spanish	es_female_elana_default	Elena	Female - Spanish	1000 credits

Callback API

Khi audio được tạo thành công, hệ thống EverAI TTS sẽ gửi đến Callback URL một HTTP POST như sau:

URL: callback url truyền lên khi gọi API Method: POST Content Type: application/json Body:

Thuộc tính	Kiểu dữ liệu	Mô tả
request_id	String	ID của request
characters		Số ký tự của đoạn văn bản đầu vào
voice_code	String	Mã giọng đọc
audio_type	String	Định dạng file audio đầu ra
speed_rate	Number	Tốc độ đọc
pitch_rate	Number	Cao độ đọc
bitrate	Number	Bitrate của file audio đầu ra
created_at	String	Thời gian khởi tạo request
status	String	Trạng thái của request * SUCCESS: Thành công * FAILURE: Thất bại
audio_link	String	Đường dẫn tải file audio tổng hợp

Example

Request

curl --location 'https://everai.vn/api/v1/tts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 5Z62rdsxxExcUOcdbukWNdRufMmxxT18g' \
--data '{
    "response_type": "indirect",
    "callback_url": "https://mydomain/callback",
    "input_text": "Chào mừng đén với EverAI",
    "voice_code": "vi_female_kieunhi_mn",
    "audio_type":"mp3",
    "bitrate": 128,
    "speed_rate": 1.0,
    "pitch_rate": 1.0
}'

Response

{
    "result": {
        "request_id": "0e7ee265-34ff-4807-b9ae-a4eb3ef24573",
        "characters": 24,
        "voice_code": "vi_female_kieunhi_mn",
        "audio_type": "mp3",
        "speed_rate": 1.0,
        "pitch_rate": 1.0,
        "bitrate": 128,
        "create_at": "2024-09-13",
        "status": "new"
    },
    "status": 1
}