メインコンテンツへスキップ
POST
cURL

承認

Authorization
string
header
必須

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

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

ボディ

application/json

チャットメッセージを送信するためのリクエストボディ。

query
string
必須

ユーザーのメッセージです。

inputs
object
必須

アプリの入力変数の値を、変数名をキーとして指定します。期待される名前と型は、アプリケーションのパラメータ情報を取得user_input_form フィールドで確認できます。

user
string
必須

エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。会話、メッセージ、ファイルは、同じ user を持つリクエストにのみ表示されます。エンドユーザーの識別 を参照してください。

response_mode
enum<string>

レスポンスの返却モードです。省略した場合はブロッキングになります。

  • streaming(推奨):応答は Server-Sent Events として届きます。
  • blocking:生成の完了後に返します。長時間の生成は中断されるおそれがあります。API の前段にあるリバースプロキシは、応答がタイムアウト内に届かないと接続を終了する場合があります。
  • Agent アプリは streaming のみに対応します。blocking のリクエストは 400 で失敗します。
利用可能なオプション:
streaming,
blocking
conversation_id
string

継続する会話の ID です。省略するか空文字列を渡すと新しい会話を開始します。レスポンスで conversation_id が返されるので、次のメッセージで渡します。以前の会話を再開するには、その ID を 会話一覧を取得 から取得します。

files
object[]

メッセージに添付するファイルです。ローカルファイルの場合は、まず ファイルをアップロード でアップロードし、返された idupload_file_id として transfer_method: local_file で参照します。

auto_generate_name
boolean
デフォルト:true

会話タイトルを自動生成します。false の場合、会話の名前を変更 API で auto_generate: true を設定して非同期でタイトルを生成します。

workflow_id
string

Chatflow アプリでのみ使用できます。 実行する公開済みワークフローバージョンの ID を指定します。指定しない場合、最新の公開バージョンが使用されます。

レスポンス

リクエスト成功。コンテンツタイプと構造はリクエストの response_mode パラメータに依存します。

  • response_modeblocking の場合、 application/jsonChatCompletionResponse オブジェクトを返します。
  • response_modestreaming の場合、text/event-stream でサーバー送信イベントのストリームを返します。
event
string

イベントタイプ。message に固定されています。

task_id
string<uuid>

リクエスト追跡およびレスポンス停止 API 用のタスク ID です。

id
string<uuid>

このレスポンスイベントの一意 ID です。

message_id
string<uuid>

一意のメッセージ ID です。フィードバックや推奨質問のエンドポイントを呼び出す際に message_id パラメータとして使用します。

conversation_id
string<uuid>

会話 ID。

mode
string

アプリモード。chat はチャットボットアプリ、agent-chat は Agent アプリ、advanced-chat は Chatflow アプリです。

answer
string

完全なレスポンスコンテンツ。

metadata
object

使用量と検索リソースを含むメタデータ。

created_at
integer<int64>

メッセージ作成タイムスタンプ(Unix エポック秒)。