Skip to content

Latest commit

 

History

History
209 lines (166 loc) · 11 KB

README.md

File metadata and controls

209 lines (166 loc) · 11 KB
Raw

TTS QUEST V3 VOICEVOX API

VOICEVOXで逐次合成した音声をストリーミング再生することにより、合成完了を待たずに音声を再生できるWEB APIです。

例（JavaScript）

Audioクラスを継承したTtsQuestV3Voicevoxクラスを使うことで、簡単にブラウザ上でストリーミング再生ができます。

var audio = new TtsQuestV3Voicevox(3, "「VOICEVOX:ずんだもん」なのだ");
audio.play();

詳細はこちら。

例（curl）

例えば、話者ID 3 に「あ」と言わせたい場合、speakerに3、textに「あ」をUTF-8でURLエンコードした%E3%81%82が対応します。

curl 'https://api.tts.quest/v3/voicevox/synthesis?speaker=3&text=%E3%81%82'

リクエストが成功した場合、

{
	"success": true,
	"isApiKeyValid": false,
	"speakerName": "VOICEVOX:ずんだもん（ノーマル）",
	"audioStatusUrl": "https://audio2.tts.quest/v1/data/a712c96d35b19275c29e93c6267581f1bf0950072e242470d098b44770bdfad2/status.json",
	"wavDownloadUrl": "https://audio2.tts.quest/v1/data/a712c96d35b19275c29e93c6267581f1bf0950072e242470d098b44770bdfad2/audio.wav",
	"mp3DownloadUrl": "https://audio2.tts.quest/v1/data/a712c96d35b19275c29e93c6267581f1bf0950072e242470d098b44770bdfad2/audio.mp3",
	"mp3StreamingUrl": "https://audio2.tts.quest/v1/data/a712c96d35b19275c29e93c6267581f1bf0950072e242470d098b44770bdfad2/audio.mp3s"
}

このようなJSONレスポンスが帰ってきます。（見やすいように一部書き換えています。改行、順序、全角文字や記号の扱いは実際と異なることがあります。） mp3形式でダウンロードしたい場合は、mp3DownloadUrlにリクエストします。

wget 'https://audio2.tts.quest/v1/data/a712c96d35b19275c29e93c6267581f1bf0950072e242470d098b44770bdfad2/audio.mp3'

wavDownloadUrlとmp3DownloadUrlは、合成が完了していないと404エラーを返し、完了するとステータスコード200を返します。 audioStatusUrlとmp3StreamingUrlは直ちに利用可能で、ステータスコードは200です。

また、ストリーミングの代わりに分割された音声ファイルをダウンロードすることもできます。例えば、「あ、い、う」という音声を合成するリクエストを送信した場合、レスポンスとaudioStatusUrlのJSONデータは次のようになります。

api.tts.questレスポンス

{
	"success": true,
	"isApiKeyValid": false,
	"speakerName": "VOICEVOX:ずんだもん（ノーマル）",
	"audioStatusUrl": "https://audio1.tts.quest/v1/data/e8ffdebfc288edb743c0bf0cf4b28834a53b26a78eeeca3586c857825ab0ae7a/status.json",
	"wavDownloadUrl": "https://audio1.tts.quest/v1/data/e8ffdebfc288edb743c0bf0cf4b28834a53b26a78eeeca3586c857825ab0ae7a/audio.wav",
	"mp3DownloadUrl": "https://audio1.tts.quest/v1/data/e8ffdebfc288edb743c0bf0cf4b28834a53b26a78eeeca3586c857825ab0ae7a/audio.mp3",
	"mp3StreamingUrl": "https://audio1.tts.quest/v1/data/e8ffdebfc288edb743c0bf0cf4b28834a53b26a78eeeca3586c857825ab0ae7a/audio.mp3s"
}

audio1.tts.questのaudioStatusUrlレスポンス

{
	"success": true,
	"isAudioReady": true,
	"isAudioError": false,
	"status": "done",
	"speaker": 3,
	"audioCount": 3,
	"updatedTime": 1684528788
}

この例では、audioStatusUrlが3となっているので、

wavファイルは

wget https://audio1.tts.quest/v1/data/e8ffdebfc288edb743c0bf0cf4b28834a53b26a78eeeca3586c857825ab0ae7a/0.wav
wget https://audio1.tts.quest/v1/data/e8ffdebfc288edb743c0bf0cf4b28834a53b26a78eeeca3586c857825ab0ae7a/1.wav
wget https://audio1.tts.quest/v1/data/e8ffdebfc288edb743c0bf0cf4b28834a53b26a78eeeca3586c857825ab0ae7a/2.wav

mp3ファイルは

wget https://audio1.tts.quest/v1/data/e8ffdebfc288edb743c0bf0cf4b28834a53b26a78eeeca3586c857825ab0ae7a/0.mp3
wget https://audio1.tts.quest/v1/data/e8ffdebfc288edb743c0bf0cf4b28834a53b26a78eeeca3586c857825ab0ae7a/1.mp3
wget https://audio1.tts.quest/v1/data/e8ffdebfc288edb743c0bf0cf4b28834a53b26a78eeeca3586c857825ab0ae7a/2.mp3

のように、合成が完了しているファイルをダウンロードすることができます。合成が完了していないファイルは404エラーを返す他、ファイルの総数が判明するまでの間のaudioCountは0です。

Web Api 仕様

各エンドポイントでは、パラメーターをGETパラメーターとPOSTフォームパラメーターで渡すことができます。

URLエンコードしたパラメーターのキーと値を=で区切り、それらを&で区切ります。同じキーが複数ある場合、どれが優先されるかは未定義です。

GETパラメーターとして渡す場合は、値をURLエンコードしてURLの末尾に記載します。

?paramA=valueA&paramB=valueB

POSTで送信する場合は、ヘッダーのcontent-typeをapplication/x-www-form-urlencodedに指定し、値をURLエンコードしてボディーに記載します。

paramA=valueA&paramB=valueB

レスポンスボディーはJSON形式で、successはステータスコードが200のときtrueとなります。 successがfalseのときは、errorMessageに理由がありますが、単にステータスコードが書かれているだけのことが多いです。 ステータスコードが429のときは、retryAfterの秒数待ってから再送してください。

エンドポイント一覧

  • https://api.tts.quest/v3/voicevox/synthesis
  • https://api.tts.quest/v3/voicevox/speakers_array
  • https://audio*.tts.quest/v1/data/*/status.json
  • https://api.tts.quest/v3/key/points
  • https://api.tts.quest/v3/key/generate

v3 voicevox synthesis

URL: https://api.tts.quest/v3/voicevox/synthesis

音声の合成をリクエストする。

パラメーター

  • speaker: 話者を表す整数値。範囲外の場合はinvalidSpeakerエラーを返す。
  • text: 合成する文章。UTF-8。文字数が0の場合はtextRequiredエラー、長すぎる場合はtextTooLongエラーを返す。
  • key: apiKey。apiKeyが有効な場合はisApiKeyValidがtrueになり、高速で合成される。

レスポンス

  • isApiKeyValid: trueのとき、apiKeyのポイントを1文字あたり1ポイント消費して高速で合成する。
  • speakerName: 話者名
  • audioStatusUrl: 合成の状況を取得するためのURL。
  • wavDownloadUrl: 合成が完了したときのwavファイルURL。
  • mp3DownloadUrl: 合成が完了したときのmp3ファイルURL。
  • mp3StreamingUrl: ストリーミング用URL。

v3 voicevox speakers_array

URL: https://api.tts.quest/v3/voicevox/speakers_array

話者の一覧を取得する。配列のキーは0で始まり、話者IDに対応する。利用できない話者IDの値はnull。

パラメーター

  • key: apiKey。apiKeyが有効な場合はisApiKeyValidがtrueになり、高速で処理される。

レスポンス

  • isApiKeyValid: trueのとき、apiKeyのポイントを1消費して高速に処理する。
  • speakers: 話者名の配列

代替

apiポイントを消費しない方法として、

から話者を取得することもできる。また、idが3の話者名は

https://static.tts.quest/voicevox_speakers_by_id/3.txt

のように、

https://static.tts.quest/voicevox_speakers_by_id/${id}.txt

でidに対応した話者名を取得できる。

v3 voicevox status

URL: https://audio*.tts.quest/v1/data/*/status.json

isAudioReadyとisAudioErrorの組み合わせで合成の状況を確認する。

レスポンス

  • isAudioReady: trueの場合、全ての合成が完了している。
  • isAudioError: trueの場合、合成に失敗している。
  • status: 完了したらdoneになる他、失敗した際には原因が書かれることがある。
  • speaker: 話者ID。
  • audioCount: 分割された音声ファイルの総数。
  • updatedTime: 更新されたUNIX時間。

v3 key points

URL: https://api.tts.quest/v3/key/points

apiKeyの残りポイント数を確認する。

パラメーター

  • key: apiKey。

レスポンス

  • isApiKeyValid: apiKeyが有効であればtrueであるが、ポイントが残っていない場合はfalseになる。
  • points: 残りポイント数。毎日朝9時（日本時間）にリセットされる。

v3 key generate

URL: https://api.tts.quest/v3/key/generate

最大24時間で、時間制限付きの使い捨てSubKeyを生成する。使用ポイント上限も設定可能。 subKeyのポイント消費は、生成に用いたapiKeyに紐付けられる。

パラメーター

  • key: apiKey。
  • time: subKeyが有効な秒数。指定がない場合は最大値の86400秒に指定される。
  • points: ポイント上限。指定がない場合は無制限。保有するポイントの総数を超えて指定することが可能。

レスポンス

  • isApiKeyValid: apiKeyが有効であればtrueであるが、ポイントが残っていない場合はfalseになる。
  • cost: subKeyの生成に消費したポイント。subKeyが有効な秒数に連動し、1分であれば1ポイント、24時間であれば1000ポイント消費する。
  • key: 生成されたsubKey。

Api Key

apiKeyはこちらで取得できます。VOICEVOX用のapiKeyを取得するのチェックボックスにチェックを入れ、VOICEVOX用API利用登録を行ってください。

すでにsu-shiki.comのapiKeyを取得している場合は、そのsha256ハッシュ値をこちらに登録して有効化してください。 別のapiKeyを登録するには、「回答を編集」から再登録してください。 なお、Googleフォームの回答を編集する際は、そのURLを公開しないでください。 「回答を編集しています。この URL を共有すると、他のユーザーもあなたの回答を編集できるようになります。」とあるように、ログインしていないユーザーでもあなたのアカウントでapiKeyを登録、上書きできてしまいます。 流出した回答フォームは無効化され、同アカウントでは一切の利用申請ができなくなります。

利用規約

VOICEVOXの利用規約、ならびにそのキャクターや音声ライブラリなどの利用規約等をご確認ください。

ＶＯＩＣＥＶＯＸ は 廣芝　和之 の登録商標または商標です。su-shiki.comとtts.questが提供するAPI、WEBサイトおよびその他の同様のコンテンツは 廣芝　和之 に承認されたものではありません。

ずんだもん は ＳＳＳ合同会社 の登録商標または商標です。