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

エラー形式

Gateway 独自のエラーは {"error":"...","message":"..."} の形で返します。 upstream の 400/404/422/500 はそのまま透過します。

statuserror意味
400invalid_request認証情報の衝突、復号できない JSON など
401invalid_api_keyAPI キーが無い / 不正 / 失効済み
403api_key_suspended管理者による一時停止
403terms_required新しい利用規約への同意が必要
403user_disabledアカウントが管理者により無効化されている
403endpoint_blocked公開対象外の endpoint
404not_found未知の endpoint
413request_too_large本文 / テキスト / 複数合成の件数が上限超過
429rate_limit_exceeded利用量の上限超過(Retry-After 付き)
429concurrency_limit_exceeded同時実行数の超過
502upstream_unavailable上流の VOICEVOX へ到達できない
503service_unavailable内部依存(Redis など)の一時障害
504upstream_timeout上流のタイムアウト