Đặc tả API
Xem thêm hướng dẫn chi tiết tại: https://documenter.getpostman.com/view/12951168/Uz5FHbSd
POST Text to speech
https://vbee.vn/api/v1/tts
Cấu trúc TTS API gửi request lên server như sau:

HTTP Request

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
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
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
sentences
Sentence
Tùy chọn (Bắt buộc khi không có input_text)
Các câu văn bản đầu vào, mỗi câu sẽ có một văn bản và mã giọng riêng
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
String
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
String
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
Kiểu Sentence (các tham số khi chuyển theo câu):
Tham số
Kiểu dữ liệu
Tính bắt buộc
Mô tả
input_text
String
Bắt buộc
Văn bản câu đầu vào
voice_code
String
Bắt buộc
Mã giọng đọc của câu đó
speed_rate
String
Tùy chọn
Dùng để điều chỉnh tốc độ của giọng đọc
Danh sách mã giọng:
  • Ngôn ngữ Tiếng Việt
HN - Ngọc Huyền: hn_female_ngochuyen_full_48k-fhg
HN - Phú Thăng: hn_male_phuthang_news65dt_44k-fhg
HN - Thanh Long: hn_male_thanhlong_talk_48k-fhg
HN - Mai Phương: hn_female_maiphuong_vdts_48k-fhg
HN - Mạnh Dũng: hn_male_manhdung_news_48k-fhg
SG - Lan Trinh: sg_female_lantrinh_vdts_48k-fhg
SG - Trung Kiên: sg_male_trungkien_vdts_48k-fhg
SG - Minh Hoàng: sg_male_minhhoang_full_48k-fhg
SG - Thảo Trinh: sg_female_thaotrinh_full_48k-fhg
Huế - Duy Phương: hue_male_duyphuong_full_48k-fhg
Huế - Hương Giang: hue_female_huonggiang_full_48k-fhg
  • Ngôn ngữ quốc tế
Mã ngôn ngữ
Tên quốc gia (VN)
Tên quốc gia (EN)
Loại giọng
Mã giọng
af-ZA
Cộng hòa Nam Phi
Afrikaans (South Africa)
Standard TTS
af-ZA-Standard-A
ar-XA
Ả Rập Xê Út
Arabic
Standard TTS
ar-XA-Standard-A
ar-XA
Ả Rập Xê Út
Arabic
Standard TTS
ar-XA-Standard-B
ar-XA
Ả Rập Xê Út
Arabic
Standard TTS
ar-XA-Standard-C
ar-XA
Ả Rập Xê Út
Arabic
Standard TTS
ar-XA-Standard-D
bg-BG
Cộng hòa Bulgaria
Bulgarian (Bulgaria)
Standard TTS
bg-bg-Standard-A
bn-IN
Tây Bengal
Bengali (India)
Standard TTS
bn-IN-Standard-A
bn-IN
Tây Bengal
Bengali (India)
Standard TTS
bn-IN-Standard-B
ca-ES
Tây Ban Nha (Catalan)
Catalan (Spain)
Standard TTS
ca-es-Standard-A
cmn-CN
Trung Quốc (Phổn thể)
Mandarin Chinese
Standard TTS
cmn-CN-Standard-A
cmn-CN
Trung Quốc (Phổn thể)
Mandarin Chinese
Standard TTS
cmn-CN-Standard-B
cmn-CN
Trung Quốc (Phổn thể)
Mandarin Chinese
Standard TTS
cmn-CN-Standard-C
cmn-CN
Trung Quốc (Phổn thể)
Mandarin Chinese
Standard TTS
cmn-CN-Standard-D
cmn-CN
Trung Quốc (Phổn thể)
Mandarin Chinese
Standard TTS
cmn-TW-Standard-A
cmn-CN
Trung Quốc (Phổn thể)
Mandarin Chinese
Standard TTS
cmn-TW-Standard-B
cmn-CN
Trung Quốc (Phổn thể)
Mandarin Chinese
Standard TTS
cmn-TW-Standard-C
cs-CZ
Cộng hòa Séc
Czech (Czech Republic)
Standard TTS
cs-CZ-Standard-A
da-DK
Đan Mạch
Danish (Denmark)
Standard TTS
da-DK-Standard-A
da-DK
Đan Mạch
Danish (Denmark)
Standard TTS
da-DK-Standard-C
da-DK
Đan Mạch
Danish (Denmark)
Standard TTS
da-DK-Standard-D

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
    • bitrate
    • create_at
    • status: trạng thái của request (IN_PROGRESS)

Callback API

Khi request thành công, hệ thống VBEE 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ả
app_id
String
ID của ứng dụng
request_id
String
ID của request
characters
Number
Số ký tự của đoạn văn bản convert
voice_code
String
Mã giọng
audio_type
String
Định dạng file audio đầu ra
speed_rate
String
Tốc độ đọ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
AUTHORIZATIONBearer TokenToken<token>BODYraw
{
"app_id": "55e0053d-f86f-4c2b-b791-b1ba6d59a868",
"callbackUrl": "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 RequestText to speechView More
curl --location --request POST 'https://vbee.vn/api/v1/tts' \
--data-raw '{
"app_id": "55e0053d-f86f-4c2b-b791-b1ba6d59a868",
"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 Response200 OKBodyHeader(13)View More
{
"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"
},
GET
Get Request
https://vbee.vn/api/v1/tts/{request_id}

API Get Request

Lấy thông tin của request bằng cách gọi API
Method: GET
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
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

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
    • bitrate
    • create_at
    • progress: phần trăm xử lý của request
    • status: trạng thái của request
    • audio_link: Đường dẫn tải file audio tổng hợp
    • audio_expired: trạng thái của audio, true nếu audio đã hết hạn lưu trữ