チャットメッセージを送信

対象アプリ：Chatflow、Agent、チャットボット、レガシー Agent。

チャットアプリにメッセージを送信し、アシスタントの応答を返します。ストリーミングレスポンスのイベントはアプリタイプによって異なります。

POST /chat-messages

cURL

blocking_example

curl --request POST \
  --url https://{api_base_url}/chat-messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2",
  "inputs": {},
  "query": "What are the specs of the iPhone 13 Pro Max?",
  "response_mode": "blocking",
  "user": "abc-123"
}
'

200

blockingResponse

{
  "answer": "iPhone 13 Pro Max specs are listed here:...",
  "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2",
  "created_at": 1705407629,
  "event": "message",
  "id": "b01a39de-3480-4f3e-9f1e-4841a80f8e5e",
  "message_id": "9da23599-e713-473b-982c-4328d4f5c78a",
  "metadata": {
    "retriever_resources": [
      {
        "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\" \"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\"",
        "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb",
        "dataset_name": "iPhone",
        "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00",
        "document_name": "iPhone List",
        "position": 1,
        "score": 0.98457545,
        "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a"
      }
    ],
    "usage": {
      "completion_price": "0.0002560",
      "completion_price_unit": "0.001",
      "completion_tokens": 128,
      "completion_unit_price": "0.002",
      "currency": "USD",
      "latency": 0.7682376249867957,
      "prompt_price": "0.0010330",
      "prompt_price_unit": "0.001",
      "prompt_tokens": 1033,
      "prompt_unit_price": "0.001",
      "total_price": "0.0012890",
      "total_tokens": 1161
    }
  },
  "mode": "chat",
  "task_id": "c3800678-a077-43df-a102-53f23ed20b88"
}

Authorizations

Authorization · string · header · required

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

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

Body

application/json

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

inputs · object · required

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

query · string · required

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

user · string · required

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

auto_generate_name · boolean · default: true

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

conversation_id · string

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

files · object[]

メッセージに添付するファイルです。ローカルファイルの場合は、まず ファイルをアップロード でアップロードし、返された id を upload_file_id として transfer_method: local_file で参照します。Agent アプリはファイル参照を受け付けますが、その内容は処理しません。

Show child attributes

response_mode · enum<string>

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

• streaming（推奨）：応答は Server-Sent Events として届きます。
• blocking：生成の完了後に返します。長時間の生成は中断されるおそれがあります。Dify Cloud では、応答がタイムアウト内に届かないと、エッジプロキシが接続を終了する場合があります。
• レガシー Agent と Agent アプリは streaming のみに対応します。blocking のリクエストは 400 で失敗します。

Available options: streaming, blocking

workflow_id · string

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

Response

200

application/json

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

• response_mode が blocking の場合、 application/json で ChatCompletionResponse オブジェクトを返します。
• response_mode が streaming の場合、text/event-stream でサーバー送信イベントのストリームを返します。

answer · string

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

conversation_id · string<uuid>

会話 ID。

created_at · integer<int64>

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

event · string

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

id · string<uuid>

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

message_id · string<uuid>

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

metadata · object

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

Show child attributes

mode · string

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

task_id · string<uuid>

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