Create speech

URL: https://vbee.vn/api/v1/tts

Method: POST

Content Type: application/json

Response Type: text/json

Tham số Header

Tham số	Giá trị	Tính bắt buộc	Mô tả
Authorization	Bearer {{token}}	Bắt buộc	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

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	Đị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. * Lưu ý: giá trị tham số bit_rate chỉ có ý nghĩa khi audio_type=mp3
speed_rate	Number	Tùy chọn	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.1 đến 1.9 và chấp nhận 1 chứ số sau dấu thập phân
sample_rate	Number	Tùy chọn	Dùng để điều chỉnh sample rate mong muốn * Giá trị của tham số sample_rate phụ thuộc vào từng giọng
emphasis_intensity	Number	Tùy chọn	Dùng để điều chỉnh mức độ nhấn nhá. Giá trị của tham số từ 0 - 100 và phải là bội số của 10. 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.

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
}