POST
/
v1
/
text-to-speech
/
{voice_id}
/
stream
Convert text to speech with streaming response
curl --request POST \
  --url https://supertoneapi.com/v1/text-to-speech/{voice_id}/stream \
  --header 'Content-Type: application/json' \
  --header 'x-sup-api-key: <x-sup-api-key>' \
  --data '{
  "text": "<string>",
  "language": "en",
  "style": "<string>",
  "model": "sona_speech_1",
  "output_format": "wav",
  "voice_settings": {
    "pitch_shift": 0,
    "pitch_variance": 1,
    "speed": 1
  }
}'
This response does not have an example.
入力されたテキストをオーディオストリーム形式で返す Streaming TTS(Text-to-Speech)API です。

基本的な使用方法

  • {voice_id}: キャラクター単位のIDのみ使用可能
  • languagestylemodelなどのパラメーターはRequest Bodyに含める必要があります

Request Body 項目の説明

項目必須説明
text変換するテキスト。最大300文字まで入力可能
languageテキストの言語。koenja のいずれか
style感情スタイル。例:neutralhappysadなど。指定がない場合、キャラクターの基本スタイルが適用されます
model使用するモデル。デフォルトは sona_speech_1。現在はこのモデルのみ利用可能
voice_settings音程/速度の調整。pitch_shiftpitch_variancespeed フィールドを含む(デフォルト:0、1、1)
output_format出力する音声ファイルの形式。wav または mp3。(デフォルト:wav

使用例

POST /v1/text-to-speech/{voice_id}/stream
Content-Type: application/json
x-sup-api-key: [YOUR_API_KEY]

{
  "text": "Thank you for calling.",
  "language": "en",
  "style": "happy",
  "model": "sona_speech_1",
  "voice_settings": {
    "pitch_shift": 0,
    "pitch_variance": 1,
    "speed": 1
  }
}

応答

  • 応答本文は バイナリチャンク として返され、デフォルトのフォーマットは wav です
  • クエリパラメーターに output_format=mp3 を指定すると、MP3形式での応答も可能です

注意事項

  • text の長さが300文字を超えると、400エラーが発生します。
  • style を指定しなくても呼び出しは可能ですが、キャラクターごとにデフォルトスタイルが異なる場合があります。
    デフォルトスタイルを確認するには、Get Voices API を使用してください(style配列の最初の値がデフォルトです)。
  • 応答で返される音声ファイルは、保存または直接再生することが可能です(クライアントに応じた適切な処理が必要です)。

Headers

x-sup-api-key
string
required

API key for the service

Path Parameters

voice_id
string
required

Query Parameters

output_format
enum<string>
default:wav

The desired output format of the audio file (wav, mp3). Default is wav.

Available options:
wav,
mp3

Body

application/json

Response

200
audio/wav

Streaming audio data in binary format

The response is of type file.