始め方
GitHub と Discord のアカウントがあれば、数分で音声を生成できます。
-
GitHub でサインイン
メールアドレスやパスワードの登録は不要です。サインイン すると Gateway のアカウントが自動作成されます(取得するのは公開プロフィールのみ)。
-
Discord アカウントを連携
ダッシュボード から連携します。1 Discord アカウントにつき 1 Gateway アカウントとすることでキーの乱発を防いでいます。連携が終わるまで API キーは発行できません。
-
API キーを発行
API キーを作成 し、利用サイトと用途を申告して利用規約に同意します。 API キーは発行直後の一度だけ表示され、サーバーにはハッシュのみ保存されます。
curl で試す
発行したキーを環境変数 VVX_KEY に入れて実行します。
1. 音声合成用のクエリを作成
curl -sS -H "Authorization: Bearer $VVX_KEY" -X POST --get \
--data-urlencode 'text=こんにちは、VOICEVOXです' \
--data-urlencode 'speaker=3' \
"https://open.voicevox.nogame-no.life/audio_query" > query.json
2. 音声を生成
curl -sS -H "Authorization: Bearer $VVX_KEY" \
-H 'Content-Type: application/json' -X POST \
-d @query.json "https://open.voicevox.nogame-no.life/synthesis?speaker=3" > voice.wav
OpenAI 互換クライアントで使う
OpenAI Text to Speech API 互換のエンドポイントも用意しています。
OpenAI SDK の base_url には https://open.voicevox.nogame-no.life/v1 を指定します。
curl -sS -H "Authorization: Bearer $VVX_KEY" \
-H 'Content-Type: application/json' -X POST \
"https://open.voicevox.nogame-no.life/v1/audio/speech" \
-d '{"model":"tts-1","input":"こんにちは、VOICEVOXです","voice":"alloy","response_format":"wav"}' \
> speech.wav
response_format は wav に対応します(VOICEVOX は WAV のみ生成します)。
対応する音声名やパラメータは API リファレンス を参照してください。
使いはじめる前に
-
ベース URL:
https://open.voicevox.nogame-no.lifeを指定します。 VOICEVOX ENGINE 互換のクライアントは、認証ヘッダを送れるものであれば概ねそのまま利用できます。 -
認証ヘッダを送れないクライアント:
VOICEVOX エディタのように
Authorizationを指定できないツールは、 IP 許可リスト で対応できます。固定 IP(サーバー / Bot / 固定回線)を登録すると、 その IP からのリクエストは API キーなしで受け付けます。IP が変わる端末(一般的な家庭用回線の エディタなど)には向きません。既定では 1 人あたり IPv4 と IPv6 のそれぞれ 1 件まで登録でき、追加は管理者へ依頼できます。 -
話者 ID:
speakerに渡す ID は クレジット一覧 で確認できます(話者ごとにスタイル別の ID があります)。 - 上限: 1 キーあたり 1,000 units / 60 分、 同時実行 4。詳しくは 利用量の上限 を参照してください。
-
クレジット表記: 生成した音声を公開するときは
VOICEVOX:四国めたん、VOICEVOX:ずんだもん、VOICEVOX:春日部つむぎのように表記します。