API リファレンス
公開 API のベース URL: https://open.voicevox.nogame-no.life
認証: Authorization: Bearer vvx_...(X-API-Key も可)。
登録した IP アドレスからのリクエストは API キーなしで受け付けます(IP 許可リスト)。
VOICEVOX 互換のリクエスト/レスポンス形式は変更していません。
この一覧は upstream の OpenAPI から許可された endpoint のみを抽出したものです。 未知の endpoint は default deny で公開されません。
| メソッド | パス | 公開範囲 | units | 説明 |
|---|---|---|---|---|
| POST | /accent_phrases | API キー必須1 unit | 1 | テキストからアクセント句を得る |
| POST | /audio_query | API キー必須1 unit | 1 | 音声合成用のクエリを作成する |
| POST | /audio_query_from_preset | API キー必須1 unit | 1 | 音声合成用のクエリをプリセットを用いて作成する |
| POST | /cancellable_synthesis | API キー必須1 unit | 1 | 音声合成する(キャンセル可能) |
| POST | /connect_waves | API キー必須1 unit | 1 | base64エンコードされた複数のwavデータを一つに結合する |
| GET | /core_versions | 認証不要 | 0 | Core Versions |
| GET | /engine_manifest | 認証不要 | 0 | Engine Manifest |
| POST | /frame_synthesis | API キー必須1 unit | 1 | Frame Synthesis |
| POST | /mora_data | API キー必須1 unit | 1 | アクセント句から音素の長さと音高を得る |
| POST | /mora_length | API キー必須1 unit | 1 | アクセント句から音素の長さを得る |
| POST | /mora_pitch | API キー必須1 unit | 1 | アクセント句から音高を得る |
| POST | /morphable_targets | API キー必須1 unit | 1 | 指定したスタイルに対してエンジン内のキャラクターがモーフィングが可能か判定する |
| POST | /multi_synthesis | API キー必須1 unit | 1 | 複数まとめて音声合成する |
| POST | /sing_frame_audio_query | API キー必須1 unit | 1 | 歌唱音声合成用のクエリを作成する |
| POST | /sing_frame_f0 | API キー必須1 unit | 1 | 楽譜・歌唱音声合成用のクエリからフレームごとの基本周波数を得る |
| POST | /sing_frame_volume | API キー必須1 unit | 1 | 楽譜・歌唱音声合成用のクエリからフレームごとの音量を得る |
| GET | /singer_info | 認証不要 | 0 | Singer Info |
| GET | /singers | 認証不要 | 0 | Singers |
| GET | /speaker_info | 認証不要 | 0 | Speaker Info |
| GET | /speakers | 認証不要 | 0 | Speakers |
| POST | /streaming_synthesis | API キー必須1 unit | 1 | ストリーミングで音声合成する |
| GET | /supported_devices | 認証不要 | 0 | Supported Devices |
| POST | /synthesis | API キー必須1 unit | 1 | 音声合成する |
| POST | /synthesis_morphing | API キー必須2 unit | 2 | 2種類のスタイルでモーフィングした音声を合成する |
| POST | /validate_kana | API キー必須1 unit | 1 | テキストがAquesTalk 風記法に従っているか判定する |
| GET | /version | 認証不要 | 0 | Version |
フィルタ済み OpenAPI: /openapi.json
Gateway 拡張(VOICEVOX 互換外)
VOICEVOX 互換ではない、ゲートウェイ独自の API です。認証・quota・利用量の扱いは 上記の VOICEVOX 互換 API と同じです。
| メソッド | パス | 公開範囲 | units | 説明 |
|---|---|---|---|---|
| POST | /v1/audio/speech | API キー必須1 unit | 1 | OpenAI Text to Speech API 互換(voice は OpenAI 音声名または VOICEVOX style id) |
| POST | /audio/speech | API キー必須1 unit | 1 | OpenAI Text to Speech API 互換(voice は OpenAI 音声名または VOICEVOX style id) |
OpenAI 互換 Text to Speech
OpenAI Text to Speech API 互換のエンドポイントです。OpenAI SDK の base_url には
https://open.voicevox.nogame-no.life/v1 を指定します(/v1 を付けない場合は
/audio/speech を別名で受理します)。
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
input: 読み上げテキスト(最大 500 文字)。voice: OpenAI 音声名(alloy,ash,ballad,coral,echo,fable,nova,onyx,sage,shimmer,verse)または VOICEVOX の style id(数値文字列)。response_format:wavのみ(省略時も wav)。mp3/opus/aac/flacはトランスコード不可のため400を返します。speed:0.25〜4.0。AudioQuery のspeedScaleに反映します。modelとinstructionsは受理して無視します。- エラーは OpenAI 形式のネスト本文
{"error":{"message","type","code"}}で返します。 - quota は 1 unit(
synthesisグループ)として計上されます。
エラー形式
Gateway 独自のエラーは {"error":"...","message":"..."} の形で返します。
upstream の 400/404/422/500 はそのまま透過します。
| status | error | 意味 |
|---|---|---|
| 400 | invalid_request | 認証情報の衝突、復号できない JSON など |
| 401 | invalid_api_key | API キーが無い / 不正 / 失効済み |
| 403 | api_key_suspended | 管理者による一時停止 |
| 403 | terms_required | 新しい利用規約への同意が必要 |
| 403 | user_disabled | アカウントが管理者により無効化されている |
| 403 | endpoint_blocked | 公開対象外の endpoint |
| 404 | not_found | 未知の endpoint |
| 413 | request_too_large | 本文 / テキスト / 複数合成の件数が上限超過 |
| 429 | rate_limit_exceeded | 利用量の上限超過(Retry-After 付き) |
| 429 | concurrency_limit_exceeded | 同時実行数の超過 |
| 502 | upstream_unavailable | 上流の VOICEVOX へ到達できない |
| 503 | service_unavailable | 内部依存(Redis など)の一時障害 |
| 504 | upstream_timeout | 上流のタイムアウト |