发送对话消息 - Dify Enterprise Docs

授权

Authorization

string

header

必填

每个请求都通过 API 密钥认证：Authorization: Bearer {API_KEY}。应用接口使用应用 API 密钥，知识库接口使用知识库 API 密钥（快速开始）。

API 密钥应保存在服务端，切勿嵌入客户端代码。缺失或无效的密钥会返回 HTTP 401（unauthorized）。

请求头

X-Trace-Id

string

与请求体字段 trace_id 相同，优先读取。

X-Trace-Session-Id

string

与请求体字段 trace_session_id 相同，优先读取。

查询参数

trace_id

string

与请求体字段 trace_id 相同，在请求头之后读取。

trace_session_id

string

与请求体字段 trace_session_id 相同，在请求头之后读取。

请求体

application/json

发送对话消息的请求体。

query

string

必填

用户发送的消息。

inputs

object

必填

应用输入变量的值，以变量名为键。请按照目标环境当前部署版本中定义的输入变量传值。

单文件变量传入一个文件对象，文件列表变量传入文件对象数组；文件对象的结构与 files 中的条目相同。

user

string

必填

终端用户标识，由你的应用定义，需在应用内唯一。会话、消息和文件仅对携带相同 user 的请求可见。参见终端用户身份。

response_mode

enum<string>

默认值:blocking

指定响应如何返回。

streaming：运行每产出一个事件就立即返回，适合快速回复以外的所有场景。
blocking：运行结束后一次性返回一个响应。

可用选项:

streaming,

blocking

conversation_id

string

要继续的会话 ID。省略或传空字符串则开启新会话，响应会返回 conversation_id，供下一条消息使用。要接着此前的会话继续，可从获取会话列表取得它的 ID。

files

object[]

随消息附带的文件。本地文件需先通过上传文件上传，再把返回的 id 作为 upload_file_id 引用，并设置 transfer_method: local_file。

Show child attributes

trace_id

string

追踪标识，会传递到可观测性数据中。可使用字母、数字、连字符和下划线，最长 128 个字符。不符合的值直接跳过，不会报错。

trace_session_id

string

追踪会话标识，会传递到可观测性数据中，去除首尾空白后长度为 1 到 200 个字符。

Required string length: 1 - 200

响应

内容类型和结构取决于请求中的 response_mode 参数。

如果 response_mode 为 blocking，返回 application/json 和 ChatCompletionResponse 对象。
如果 response_mode 为 streaming，返回 text/event-stream 和服务器发送事件流。

event

string

固定为 message。

task_id

string

本次运行的任务 ID。使用阻塞式返回时，任务 ID 只出现在最终响应体中，因此停止对话消息生成实际只在流式返回时可用。

string

消息 ID。

message_id

string

消息 ID，与 id 取值相同。

conversation_id

string

本轮对话所属的会话；省略 conversation_id 时，返回新建会话的 ID。

mode

string

固定为 advanced-chat。

answer

string

完整的回答文本。

metadata

object

运行元数据，其中 usage 包含 token 数量、费用和延迟。

created_at

integer

运行开始时间，Unix 时间戳（秒）。