voai.ai VoiceAPI 使用說明

1. 取得speaker列表

請求方式

curl --location 'https://connect.voai.ai/TTS/GetSpeaker' \
    --header 'x-api-key: your-api-key'

說明

用於取得可供您使用的speaker列表，返回的結果包含每個模型中的speaker的詳細資訊，如名稱、語言和語音風格等。

2-1 文本轉語音(簡易)

請求方式

curl --location 'https://connect.voai.ai/TTS/Speech' \
         --header 'x-output-format: wav' \
         --header 'x-api-key: {your-api-key}' \
         --header 'Content-Type: application/json' \
         --data '{
             "version": "Neo",
             "text": "網際智慧的聲音，是業界的標竿。",
             "speaker": "佑希",
             "style": "預設",
             "speed": 1,
             "pitch_shift": 0,
             "style_weight": 0,
             "breath_pause": 0
         }'

說明

用於將指定的文本轉換為語音，並以指定的格式返回音頻文件。你可以透過 x-output-format 頭字段選擇輸出格式（如 wav）。

• version: 選擇模型的版本，如"Classic"、"Neo"等等。
• text: 要轉換為語音的文本內容。
• speaker: 選擇的發音人。
• style: 語音風格。
• speed: 語速調整，預設值為 1。有效範圍為 [0.5, 1.5]。
• pitch_shift: 音調調整，預設值為 0。有效範圍為 [-5, 5]。
• style_weight: 語音風格權重，預設值為 0。有效範圍為 [0, 1]。"Neo"模型中此參數無效用。
• breath_pause: 調整句間的間隔長度(秒)，範圍在 [0, 10] 之間。

2-2 文本轉語音（進階）

請求方式

curl --location 'https://connect.voai.ai/TTS/generate-voice' \
        --header 'x-output-format: wav' \
        --header 'x-api-key: {your-api-key}' \
        --header 'Content-Type: application/json' \
        --data '{
            "input": {
                "voai_script_text": "網際智慧的聲音，不僅清晰自然，還融入了情感與真實感，展現了[:2]先進技術的極致魅力。它是業界的標竿，深受廣大用戶的信賴與推崇，是現代智慧語音技術的代表作。"
            },
            "voice": {
                "name": "佑希",
                "style": "預設",
                "model": "Neo"
            },
            "audio_config": {
                "speed": 1,
                "pitch_shift": 0,
                "style_weight": 0,
                "breath_pause": 0
            }
        }'

說明

適用於長文本。該 API 用於將指定的文本轉換為語音，並且支援voai的停頓標籤語法，返回音檔文件。你可以透過 x-output-format 頭字段選擇輸出格式（如 wav）。

• voai_script_text: 欲轉換為語音的文本內容，支援特殊標記（例如 [:2] 表示停頓2秒。）。需注意以下限制：
  • 1. 停頓間隔限制: 任意兩個停頓標記之間的文本不宜過短(建議不少於20字)
  • 2. 位置限制: 停頓標記與開頭或結尾字之間的文本不宜過短(建議不少於20字)
  • 3. 有效位數至小數點後一位
  • 4. 至多可輸入5秒，超過5秒者視為5秒
• name: 配音員名稱。
• style: 語音風格，例如「預設」、「可愛」、「聊天」等等。支援的風格請參考 GetSpeaker api
• model: 模型版本，支援：
  • Classic: 高效率模型，適合快速生成，適用於日常應用。
  • Neo: 注重情感表達的模型，適合短影音及故事朗讀。
• speed: 語速調整，預設值為 1。有效範圍為 [0.5, 1.5]。
• pitch_shift: 音調調整，預設值為 0。有效範圍為 [-5, 5]。
• style_weight: 調整語音風格的權重，範圍為 [0, 1]，僅支援 Classic 模型。
• breath_pause: 調整句間的間隔長度（秒），範圍為 [0, 10]。

3. 查看 API 使用配額

請求方式

curl --location 'https://connect.voai.ai/Key/Usage' \
    --header 'x-api-key: your-api-key'
    

說明

返回您的 API 金鑰使用配額資訊。