Skip to main content
post/text-to-audio
Request example
Response
post/text-to-audio

Authorization

Authorizationstringheaderrequired#

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

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

Body

application/json
message_idstring#
回答を音声化するメッセージの ID です。両方が指定された場合、text よりも優先されます。メッセージ ID は 会話履歴メッセージ一覧を取得 から取得します。
streamingboolean#
後方互換性のために受け付けられますが、効果はありません。音声がストリーミングされるかどうかは、設定された TTS プロバイダーの出力によって決まり、このフィールドでは制御されません。
textstring#
音声に合成するテキストです。
userstring#
エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。エンドユーザーの識別 を参照してください。
voicestring#
テキスト読み上げに使用する音声。利用可能な音声は、このアプリに設定された TTS プロバイダーによって異なります。デフォルトにはアプリケーションのパラメータ情報を取得 → text_to_speech.voice の voice 値を使用してください。

Responses

生成された音声を返します。Content-Type ヘッダーはプロバイダーが返す音声コンテナ形式を反映し、認識可能な場合はレスポンスのバイト列から検証されます。

レスポンスボディは AAC、FLAC、MP4、MP3、Ogg、WAV、WebM のいずれかです。認識できない出力には、プロバイダーが宣言した形式が設定されます。宣言がない場合は audio/mpeg になります。

プロバイダーがストリームを返す場合はチャンク転送エンコーディングで配信されます。リクエストの streaming フィールドはこの動作を制御しません。