API リファレンステキスト読み上げリアルタイムテキスト読み上げ
リアルタイムテキスト読み上げ v1
凍結された Realtime TTS WebSocket v1 を使用する既存クライアントを保守します。
Realtime TTS v1 は凍結された互換契約です。新規統合では上位の v3 契約を使用してください。v1、v2、v3 のイベントとフィールドに互換性はありません。
エンドポイント、認証、エンコード
| 項目 | 値 |
|---|---|
| WebSocket | wss://realtime.fishaudio.org/v1/tts/live |
| サブプロトコル | realtime.tts.msgpack.v1 |
| エンコード | MessagePack バイナリフレーム |
Authorization: Bearer FISHAUDIO_API_KEY
Sec-WebSocket-Protocol: realtime.tts.msgpack.v1認証情報を URL やブラウザーコードに含めないでください。
イベントフロー
authenticated → start → ready → text → flush → audio → usage → stop → finishクライアントイベントは start、text、flush、stop、ping。サーバーイベントは authenticated、ready、audio、usage、pong、warning、finish、error です。音声は audio.data に入り、stop 前に複数の text → flush セグメントを送信できます。
start.request
| フィールド | 規則 |
|---|---|
model_id | 必須の公開音声/モデル UUID。modelId も使用可能。 |
engine_model_id | 任意。別名は engineModelId。 |
format | mp3、wav、pcm、opus。既定値 mp3。 |
speed / volume | 0.5–2 / 0–10。 |
language | 1–32 文字。 |
chunk_length | 100–300 の整数。 |
latency | normal または balanced。 |
すべてのメッセージは MessagePack Map で、不明なフィールドは拒否されます。課金は受理された flush セグメント単位です。v1 には永続的な再実行やセグメント冪等性がありません。エラーは code、message、retryable を含みます。新機能には Realtime TTS v3 を使用してください。