> For the complete documentation index, see [llms.txt](https://help.everai.vn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.everai.vn/api-docs/text-to-speech/post-text-to-speech.md).

# \[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**: <mark style="color:blue;"><https://www.everai.vn/api/v1/tts></mark>\
**Method**: POST\
**Content Type**: application/json\
**Response Type**: text/json

#### Tham số header

<table><thead><tr><th width="153">Tham số</th><th width="131">Kiểu dữ liệu</th><th width="143" data-type="checkbox">Tính bắt buộc</th><th>Mô tả</th></tr></thead><tbody><tr><td>Authorization</td><td>Bearer Token</td><td>true</td><td>API key của người dùng, được tạo trong giao diện tại https://everai.vn/api</td></tr></tbody></table>

#### Cấu trúc body của request

<table><thead><tr><th width="155">Tham số</th><th width="130">Kiểu dữ liệu</th><th width="143" data-type="checkbox">Tính bắt buộc</th><th>Mô tả</th></tr></thead><tbody><tr><td>response_type</td><td>String</td><td>false</td><td>indirect</td></tr><tr><td>callback_url</td><td>String</td><td>false</td><td>Đường dẫn Webhook để nhận kết quả của request</td></tr><tr><td>input_text</td><td>String</td><td>true</td><td>Văn bản đầu vào cần tổng hợp</td></tr><tr><td>voice_code</td><td>String</td><td>true</td><td>Mã giọng đọc cần tổng hợp</td></tr><tr><td>model_id</td><td>String</td><td>false</td><td>Mã mô hình, chỉ áp dung cho các giọng tiêu chuẩn. Các mô hình khả dụng:<br>* everai-v1.6: Hỗ trợ đa ngôn ngữ, chất lượng âm thanh cao<br>* everai-v1.5: hỗ trợ tiếng Anh và tiếng Việt, tối ưu riêng cho tiếng Việt <br>* everai-v1.5-turbo: tốc độ nhanh với chi phí bằng 50%. Chất lượng gần tương đương everai-v1.5<br>* everai-v1: Mô hình nền tảng ban đầu.<br>Giá trị mặc định là everai-v1.5</td></tr><tr><td>audio_type</td><td>String</td><td>false</td><td>Định dạng loại file audio đầu ra<br>* Giá trị mặc định: mp3<br>* Giá trị <strong>audio_type</strong> cho phép truyền vào là: mp3, wav</td></tr><tr><td>bitrate</td><td>Number</td><td>false</td><td>Quy định bit rate (bps) của audio đầu ra<br>* Giá trị mặc định: 128<br>* Giá trị <em><strong>bit_rate</strong></em> cho phép truyền vào là: 8, 16, 32, 64, 128, 160<br>* Lưu ý: giá trị tham số <em><strong>bit_rate</strong></em> chỉ có ý nghĩa khi <strong>audio_type=mp3</strong></td></tr><tr><td>speed_rate</td><td>Number</td><td>false</td><td>Điều chỉnh tốc độ của giọng đọc<br>* Giá trị mặc định: 1.0<br>* Giá trị của tham số <strong>speed_rate</strong> 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</td></tr><tr><td>pitch_rate</td><td>Number</td><td>false</td><td>Điều chỉnh độ của giọng đọc<br>* Giá trị mặc định: 1.0<br>* Giá trị của tham số <strong>pitch_rate</strong> 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</td></tr><tr><td>volume</td><td>Number</td><td>false</td><td>Điều chỉnh âm lượng của giọng đọc<br>* Giá trị mặc định: 100<br>* Giá trị của tham số <strong>volume</strong> có thể chạy từ 50 đến 150 và chấp nhận số nguyên</td></tr><tr><td>generate_srt</td><td>Boolean</td><td>false</td><td>Xác định xem có sinh file phụ đề srt cho audio đầu ra hay không<br>* Giá trị mặc định: false</td></tr></tbody></table>

#### Kết quả trả về

* status: trạng thái của API (1: thành công, 0: thất bại)&#x20;
* 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&#x20;
  * request\_id: mã request&#x20;
  * characters: số ký tự của đoạn văn bản convert&#x20;
  * voice\_code&#x20;
  * audio\_type&#x20;
  * speed\_rate&#x20;
  * pitch\_rate&#x20;
  * bitrate&#x20;
  * create\_at&#x20;
  * 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.](https://everai.vn/voice-cloning)

Để 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.

<figure><img src="/files/ZNjBsnFZ9hddcqPyCVfR" alt=""><figcaption></figcaption></figure>

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

<table><thead><tr><th width="122">Ngôn ngữ</th><th width="220">Mã giọng</th><th width="109">Tên</th><th width="143">Giới tính</th><th>Giá / 1000 ký tự</th></tr></thead><tbody><tr><td>Việt Nam</td><td>vi_male_lehoang_mb</td><td>Lê Hoàng</td><td>Nam - Miền Bắc</td><td>1000 credits<br></td></tr><tr><td>Việt Nam</td><td>vi_female_thuytrang_mb</td><td>Thùy Trang</td><td>Nữ - Miền Bắc</td><td>1000 credits<br></td></tr><tr><td>Việt Nam</td><td>vi_male_minhtriet_mb</td><td>Minh Triết</td><td>Nam - Miền Bắc</td><td>1000 credits<br></td></tr><tr><td>Việt Nam</td><td>vi_male_echo_default</td><td>Echo</td><td>Nam - Giọng Mỹ</td><td>100 credits<br></td></tr><tr><td>Việt Nam</td><td>vi_female_nova_default</td><td>Nova</td><td>Nữ - Giọng Mỹ</td><td>100 credits<br></td></tr><tr><td>Việt Nam</td><td>vi_male_onyx_default</td><td>Onyx</td><td>Nam - Giọng Mỹ</td><td>100 credits<br></td></tr><tr><td>Việt Nam</td><td>vi_female_hacuc_mb</td><td>Hạ Cúc</td><td>Nữ - Miền Bắc</td><td>1000 credits<br></td></tr><tr><td>Việt Nam</td><td>vi_male_ductrong_mb</td><td>Đức Trọng </td><td>Nam - Miền Bắc</td><td>1000 credits<br></td></tr><tr><td>Việt Nam</td><td>vi_female_kieunhi_mn</td><td>Kiều Nhi</td><td>Nữ - Miền Nam</td><td>1000 credits<br></td></tr><tr><td>Việt Nam</td><td>vi_female_huyenanh_mb</td><td>Huyền Anh</td><td>Nữ - Miền Bắc</td><td>1000 credits<br></td></tr><tr><td>Việt Nam</td><td>vi_female_halinh_mb</td><td>Hà Linh</td><td>Nữ - Miền Bắc</td><td>1000 credits<br></td></tr><tr><td>Việt Nam</td><td>vi_female_hoaian_mb</td><td>Hoài An</td><td>Nữ - Miền Bắc</td><td>1000 credits<br></td></tr><tr><td>Việt Nam</td><td>vi_female_khanhhuyentvc_mb</td><td>Khánh Huyền </td><td>Nữ - Miền Bắc</td><td>1000 credits<br></td></tr><tr><td>English</td><td>en_male_echo_default</td><td>Echo</td><td>Male - American</td><td>100 credits<br></td></tr><tr><td>English</td><td>en_female_nova_default</td><td>Nova</td><td>Female - American</td><td>100 credits<br></td></tr><tr><td>English</td><td>en_male_onyx_default</td><td>Echo</td><td>Male - American</td><td>100 credits<br></td></tr><tr><td>English</td><td>en_female_emily_us</td><td>Emily</td><td>Female - American</td><td>1000 credits<br></td></tr><tr><td>English</td><td>en_female_alice_default</td><td>Alice</td><td>Female - American</td><td>1000 credits<br></td></tr><tr><td>English</td><td>en_female_jessica_au</td><td>Jessica</td><td>Female - Australian</td><td>1000 credits<br></td></tr><tr><td>English</td><td>en_female_elara_br</td><td>Elara</td><td>Female - British</td><td>1000 credits<br></td></tr><tr><td>English</td><td>en_female_meera_indian</td><td>Meera</td><td>Female - Indian</td><td>1000 credits<br></td></tr><tr><td>Chinese</td><td>zh_female_liu-ying_default</td><td>Liu Ying</td><td>Female - Chinese</td><td>1000 credits<br></td></tr><tr><td>Japanese</td><td>jp_female_yuki_default</td><td>Yuki</td><td>Female - Japanese</td><td>1000 credits<br></td></tr><tr><td>Korean</td><td>kr_female_seo-yeon_default</td><td>Seo Yeon</td><td>Female - Korean</td><td>1000 credits<br></td></tr><tr><td>French</td><td>fr_female_camille_default</td><td>Camille</td><td>Female - French</td><td>1000 credits<br></td></tr><tr><td>Spanish</td><td>es_female_elana_default</td><td>Elena</td><td>Female - Spanish</td><td>1000 credits<br></td></tr></tbody></table>

## Callback API <a href="#callback-api" id="callback-api"></a>

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       | <p>Trạng thái của request<br>\* <strong>SUCCESS:</strong> Thành công<br>\* <strong>FAILURE:</strong> Thất bại</p> |
| 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
}
```