Voice Library API
Tổng quan
Giới thiệu
API cung cấp các chức năng quản lý và thao tác với các giọng nói (voices), bao gồm việc lấy danh sách giọng nói, thêm mới, xóa và chỉnh sửa.
Quick Start
- Đăng ký và lấy API Key từ hệ thống.
- Gửi các yêu cầu API qua HTTP với API Key trong header.
- Sử dụng các endpoint để quản lý giọng nói.
Xác thực
API yêu cầu cung cấp API Key qua header X-API-Key
. API Key phải được bảo mật và không chia sẻ công khai.
Base URL
https://api.ausynclab.org/api/v1/voices
Playground
https://api.ausynclab.org/docs (opens in a new tab)
Chi tiết Endpoints
1. Đăng ký giọng nói
URL: https://api.ausynclab.org/api/v1/voices/register
Phương thức: POST
Mô tả: Đăng ký một giọng nói mới.
Tham số Query:
name
: Tên giọng nói.language
: Ngôn ngữ (vi
,en
). Quan trọng: phải input chính xác ngôn ngữ tương ứng với đoạn audio.gender
: Giới tính (MALE
,FEMALE
).age
: Độ tuổi (YOUNG
,MIDDLE_AGED
,OLD
).use_case
: Trường hợp sử dụng (CASUAL
,NARRATION
,ADVERTISEMENT
,REPORTING
).
Body:
Dữ liệu audio file wav hoặc mp3 tải lên dưới dạng multipart/form-data
.
CURL:
curl -X 'POST' \
'https://api.ausynclab.org/api/v1/voices/register?name=Sample%20Voice&language=vi&gender=FEMALE&age=YOUNG&use_case=CASUAL' \
-H 'accept: application/json' \
-H 'X-API-Key: your_api_key' \
-H 'Content-Type: multipart/form-data' \
-F 'audio_file=@AudioFile.wav;type=audio/wav'
Phản hồi:
- 200 OK
{
"status": 200,
"result": {
"id": 1000
}
}
2. Lấy thông tin chi tiết giọng nói
URL: https://api.ausynclab.org/api/v1/voices/{voice_id}
Phương thức: GET
Mô tả: Lấy thông tin chi tiết của một giọng nói.
Tham số:
voice_id
(bắt buộc): ID của giọng nói (kiểuinteger
).
CURL:
curl -X 'GET' \
'https://api.ausynclab.org/api/v1/voices/1000' \
-H 'accept: application/json' \
-H 'X-API-Key: your_api_key'
Phản hồi:
- 200 OK
{
"status": 200,
"result": {
"id": 1000,
"name": "Sample 1",
"language": "vi",
"gender": "FEMALE",
"age": "YOUNG",
"use_case": "CASUAL",
"audio_url": "https://cdn-ausync-endpoint.azureedge.net/audio/sample_path.wav"
}
}
- 404 Not Found: Không tìm thấy giọng nói.
3. Lấy danh sách giọng nói
URL: https://api.ausynclab.org/api/v1/voices/list
Phương thức: GET
Mô tả: Lấy danh sách các giọng nói.
CURL:
curl -X 'GET' \
'https://api.ausynclab.org/api/v1/voices/list' \
-H 'accept: application/json' \
-H 'X-API-Key: your_api_key'
Phản hồi:
- 200 OK
{
"status": 200,
"result": [
{
"id": 1000,
"name": "Sample 1",
"language": "vi",
"gender": "FEMALE",
"age": "YOUNG",
"use_case": "CASUAL",
"audio_url": "https://cdn-ausync-endpoint.azureedge.net/audio/sample_path.wav"
},
{
"id": 1001,
"name": "Sample 2",
"language": "vi",
"gender": "FEMALE",
"age": "YOUNG",
"use_case": "CASUAL",
"audio_url": "https://cdn-ausync-endpoint.azureedge.net/audio/sample_path.wav"
}
]
}
- 404 Not Found: Không tìm thấy giọng nói.
4. Xóa giọng nói
URL: https://api.ausynclab.org/api/v1/voices/{voice_id}
Phương thức: DELETE
Mô tả: Xóa một giọng nói theo voice_id
.
Tham số:
voice_id
(bắt buộc): ID của giọng nói.
CURL:
curl -X 'DELETE' \
'https://api.ausynclab.org/api/v1/voices/1000' \
-H 'accept: application/json' \
-H 'X-API-Key: your_api_key'
Phản hồi:
- 200 OK
{
"status": 200,
"result": {
"id": 1000
}
}
- 404 Not Found: Không tìm thấy giọng nói.