# Create speech

**URL**: <https://vbee.vn/api/v1/tts>

**Method**: POST

**Content Type**: application/json

**Response Type**: text/json

**Tham số Header**

<table data-header-hidden><thead><tr><th></th><th width="187"></th><th></th><th></th></tr></thead><tbody><tr><td><strong>Tham số</strong></td><td><strong>Giá trị</strong></td><td><strong>Tính bắt buộc</strong></td><td><strong>Mô tả</strong></td></tr><tr><td>Authorization</td><td>Bearer {{token}}</td><td>Bắt buộc</td><td>Token đại diện cho App gọi API, được sinh ra dưới dạng JWT có thời hạn do lúc khởi tạo App người dùng chọn</td></tr></tbody></table>

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

| **Tham số**         | **Kiểu dữ liệu** | **Tính bắt buộc**                          | **Mô tả**                                                                                                                                                                                                                                                                                     |
| ------------------- | ---------------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| app\_id             | String           | Bắt buộc                                   | ID của ứng dụng, được sinh ra khi khởi tạo App                                                                                                                                                                                                                                                |
| response\_type      | String           | Có                                         | Giá trị: indirect                                                                                                                                                                                                                                                                             |
| callback\_url       | String           | Bắt buộc                                   | Webhook để nhận kết quả của request                                                                                                                                                                                                                                                           |
| input\_text         | String           | Tùy chọn (Bắt buộc khi không có sentences) | Văn bản đầu vào cần tổng hợp                                                                                                                                                                                                                                                                  |
| voice\_code         | String           | Tùy (Bắt buộc khi có input\_text)          | Mã giọng đọc cần tổng hợp                                                                                                                                                                                                                                                                     |
| audio\_type         | String           | Tùy chọn                                   | <p>Định dạng loại file audio đầu ra</p><p>\* Giá trị mặc định: mp3</p><p>\* Giá trị audio\_type cho phép truyền vào là: mp3, wav</p>                                                                                                                                                          |
| bitrate             | Number           | <p><br></p>                                | <p>Dùng để chuyển đầu ra về bit rate (bps) mong muốn</p><p>\* Giá trị mặc định: 128</p><p>\* Giá trị bit\_rate cho phép truyền vào là: 8, 16, 32, 64, 128.</p><p>\* Lưu ý: giá trị tham số bit\_rate chỉ có ý nghĩa khi audio\_type=mp3</p>                                                   |
| speed\_rate         | Number           | Tùy chọn                                   | <p>Dùng để điều chỉnh tốc độ của giọng đọc</p><p>\* Giá trị mặc định: 1.0</p><p>\* Giá trị của tham số speed\_rate có thể chạy từ 0.1 đến 1.9 và chấp nhận 1 chứ số sau dấu thập phân</p>                                                                                                     |
| sample\_rate        | Number           | Tùy chọn                                   | <p>Dùng để điều chỉnh sample rate mong muốn</p><p>\* Giá trị của tham số sample\_rate phụ thuộc vào từng giọng</p>                                                                                                                                                                            |
| emphasis\_intensity | Number           | Tùy chọn                                   | <p>Dùng để điều chỉnh mức độ nhấn nhá.</p><p>Giá trị của tham số từ 0 - 100 và phải là bội số của 10.</p><p>Lưu ý: Tham số này chỉ áp dụng với giọng có hỗ trợ chức năng nhấn nhá. Giọng nhấn nhá là giọng đọc có field "has\_emphasis" trong kết quả trả về của API lấy danh sách giọng.</p> |

**Chú ý:**

***Các audio link trả về chỉ có thời hạn trong vòng 3 phút, sau 3 phút audio link sẽ hết hạn và không thể sử dụng. Audio vẫn sẽ được lưu trữ trên hệ thống trong vòng 3 ngày kể từ thời điểm chuyển văn bản thành công. Muốn lấy link mới, bạn gọi api Get Request (bên dưới) để lấy lại audio link mới.***

**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
* **error\_message**: chi tiết lỗi
* **result**: dữ liệu trả về khi gọi API thành công
  * app\_id
  * request\_id: mã request
  * characters: số ký tự của đoạn văn bản convert
  * voice\_code
  * audio\_type
  * speed\_rate
  * sample\_rate
  * bitrate
  * create\_at
  * status: trạng thái của request (IN\_PROGRESS)

```
// Example request
curl --location 'https://vbee.vn/api/v1/tts' \
--data '{
    "app_id": "55e0053d-f86f-4c2b-b791-b1ba6d59a868",
    "response_type": "indirect",
    "callback_url": "https://mydomain/callback",
    "input_text": "Chào mừng đén với website của chúng tôi! Đây là trang web cung cấp một giải pháp văn bản thành giọng nói, trên cơ sở, nó hỗ trợ các doanh nghiệp xây dựng các hệ thống trung tâm cuộc gọi tự động, hệ thống thông báo công khai, trợ lý ảo, tin tức âm thanh, podcast, sách âm thanh và tường thuật phim.",
    "voice_code": "hn_female_ngochuyen_full_48k-fhg",
    "audio_type":"mp3",
    "bitrate": 128,
    "speed_rate": "1.0"
}'
```

```
// Example response
{
  "result": {
    "app_id": "55e0053d-f86f-4c2b-b791-b1ba6d59a868",
    "audio_type": "mp3",
    "bitrate": 128,
    "characters": 297,
    "request_id": "5509d1e6-8906-4291-899b-c25643a624af",
    "speed_rate": "1.0",
    "status": "IN_PROGRESS",
    "voice_code": "hn_female_ngochuyen_full_48k-fhg"
  },
  "status": 1
}
```
