メインコンテンツへスキップ
POST
テキストを音声に変換

承認

Authorization
string
header
必須

すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401unauthorized)で失敗します。

ボディ

application/json

テキストから音声への変換のリクエストボディ。message_id または text のいずれかを指定してください。

message_id
string<uuid>

回答を音声化するメッセージの ID です。両方が指定された場合、text よりも優先されます。メッセージ ID は 会話履歴メッセージ一覧を取得 から取得します。

text
string

音声に合成するテキストです。

user
string

エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。エンドユーザーの識別 を参照してください。

voice
string

テキスト読み上げに使用する音声。利用可能な音声は、このアプリに設定された TTS プロバイダーによって異なります。デフォルトにはアプリケーションのパラメータ情報を取得text_to_speech.voicevoice 値を使用してください。

streaming
boolean

後方互換性のために受け付けられますが、効果はありません。音声がストリーミングされるかどうかは、設定された TTS プロバイダーの出力によって決まり、このフィールドでは制御されません。

レスポンス

生成された音声ファイルを返します。Content-Type ヘッダーは音声の MIME タイプ(例:audio/wavaudio/mp3)に設定されます。設定された TTS プロバイダーがストリームを返す場合、音声は audio/mpeg としてチャンク転送エンコーディングで配信されます。リクエストの streaming フィールドはこれを制御しません。

The response is of type file.