概要

VOICEVOX Public API Gateway は、既存の VOICEVOX ENGINE クラスタへ API キー認証つきで アクセスできるようにする公開ゲートウェイです。API の形は VOICEVOX ENGINE HTTP API と 互換で、/audio_query → /synthesis の流れをそのまま使えます。 通常は Authorization ヘッダを追加するだけで、これを送れないクライアント向けには IP 許可リストによる認証も用意しています。

公開している API(8 + 18 endpoints)

  • 認証不要・0 units(8 件): /version, /speakers, /speaker_info, /engine_manifest, /singers など。話者メタデータの取得に使えます。
  • API キー必須(18 件、1 unit 〜): /audio_query → /synthesis の基本フロー、 /streaming_synthesis、/multi_synthesis、 /synthesis_morphing(2 units)、歌唱系の /sing_frame_* など。
  • 一覧は API リファレンス と、許可した endpoint だけを抽出した /openapi.json にあります。
  • Gateway 拡張(VOICEVOX 互換外、1 unit 〜): OpenAI Text to Speech API 互換の POST /v1/audio/speech も提供しています。 認証・quota・エラー形式は上記と同じ扱いで、voice には OpenAI 音声名または VOICEVOX の style id を指定できます。詳細は API リファレンス にあります。

公開しない API(14 件)

共有エンジンの状態を変更・参照する API は公開しません。403 endpoint_blocked を返します。

  • /setting(GET / POST)
  • /user_dict, /import_user_dict, /user_dict_word
  • /presets, /add_preset, /update_preset, /delete_preset

未知の endpoint は default deny(404 not_found)。 VOICEVOX が新しい API を追加しても、内容を人が確認するまで自動公開しません。

このゲートウェイが担う範囲

責務をはっきりさせておくための一覧です。
項目内容
認証 Authorization: Bearer vvx_...(X-API-Key も可)。 API キーの値は SHA-256 のみを保存し、平文は保持しません。 ヘッダを送れないクライアントは IP 許可リスト を利用できます。
利用量の制御 キーごとの rolling window と同時実行数。利用量の上限 を参照してください。
音声の生成 上流の VOICEVOX ENGINE が行います。ゲートウェイは入力テキスト・AudioQuery・生成音声を 保存せず、応答をそのまま転送します。
クレジット表記 代行しません。利用者の義務です(話者ごとのクレジット)。

本サービスは有志(FelNull)が運営する非公式のゲートウェイで、VOICEVOX 公式および各音声ライブラリの 提供元とは関係ありません。VOICEVOX 本体と各ライブラリの条件は 公式の利用規約 を確認してください。