Developer REST API v1

Tài Liệu Tích Hợp OmniVoice AI API

Hướng dẫn đầy đủ cách kết nối, tạo API Key, gửi yêu cầu tạo audio và nhận phản hồi Webhook HMAC.

1. Khởi tạo API Key

Đăng nhập vào Dashboard > Quản lý API Key và tạo một key mới. Mã key có dạng ov_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.

2. Endpoint Tạo Audio (`POST /api/v1/audio/generate`)

curl -X POST "http://localhost:3000/api/v1/audio/generate" \
  -H "Authorization: Bearer ov_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Xin chào từ API OmniVoice AI",
    "voice_id": "vi_female_01",
    "language": "vi",
    "speed": 1.0,
    "pitch": 0.0,
    "format": "mp3"
  }'

3. Endpoint Kiểm Tra Trạng Thái (`GET /api/v1/audio/jobs/:job_id`)

Request kiểm tra kết quả xử lý của job:

GET /api/v1/audio/jobs/job_123456

4. Bảng Mã Lỗi (Error Codes Reference)

Error Code	HTTP Status	Mô tả
UNAUTHORIZED	401	Thiếu Authorization Header hoặc token sai định dạng.
INVALID_API_KEY	401	API Key không tồn tại hoặc đã bị thu hồi.
QUOTA_EXCEEDED	403	Hạn mức số lượng ký tự còn lại không đủ.
RATE_LIMIT_EXCEEDED	429	Vượt quá tần suất request cho phép của gói cước.