发送消息

适用于：文本生成应用。

向文本生成型应用发送请求并返回生成的文本。

POST /completion-messages

cURL

streaming_example

curl --request POST \ --url https://{api_base_url}/completion-messages \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data @- <<EOF { "inputs": { "city": "San Francisco" }, "query": "Translate 'hello' to Spanish.", "response_mode": "streaming", "user": "abc-123", "files": [ { "type": "image", "transfer_method": "remote_url", "url": "https://cloud.dify.ai/logo/logo-site.png" } ] } EOF

200

blockingResponse

{ "event": "message", "task_id": "c3800678-a077-43df-a102-53f23ed20b88", "id": "b01a39de-3480-4f3e-9f1e-4841a80f8e5e", "message_id": "9da23599-e713-473b-982c-4328d4f5c78a", "mode": "completion", "answer": "Hello World!...", "metadata": { "usage": { "prompt_tokens": 1033, "prompt_unit_price": "0.001", "prompt_price_unit": "0.001", "prompt_price": "0.0010330", "completion_tokens": 128, "completion_unit_price": "0.002", "completion_price_unit": "0.001", "completion_price": "0.0002560", "total_tokens": 1161, "total_price": "0.0012890", "currency": "USD", "latency": 0.7682376249867957 } }, "created_at": 1705407629 }

Authorizations

Authorization · string · header · required

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

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

Body

application/json

创建文本生成消息的请求体。

inputs · object · required

应用输入变量的值，以变量名为键。变量名称和类型可从 获取应用参数 响应中的 user_input_form 字段获取。

user · string · required

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

query · string · default: ""

要处理的文本。旧版字段；较新的应用改为在 inputs 中传递。

response_mode · enum<string>

响应返回模式。streaming（推荐）使用 SSE。blocking 等待完成后返回（长时间处理可能会被中断）。Cloudflare 超时为 100 s。省略时默认为阻塞模式。

Available options: streaming, blocking

files · object[]

要附加到请求的文件。本地文件需先通过 上传文件 上传，再将返回的 id 作为 upload_file_id 引用，并设置 transfer_method: local_file。

Option 1

Option 2

Show child attributes

Response

200

application/json

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

• 如果 response_mode 为 blocking，返回 application/json 和 CompletionResponse 对象。
• 如果 response_mode 为 streaming，返回 text/event-stream 和 ChunkCompletionEvent 对象流。

event · string

事件类型，固定为 message。

task_id · string<uuid>

用于请求追踪和 停止响应 API 的任务 ID。

id · string<uuid>

该响应事件的唯一 ID。

message_id · string<uuid>

唯一的消息 ID。调用反馈或推荐问题接口时，将此值作为 message_id 参数使用。

mode · string

应用模式，固定为 completion。

answer · string

完整的响应内容。

metadata · object

包含用量和检索资源的元数据。

Show child attributes

created_at · integer<int64>

消息创建时间戳（Unix 纪元秒）。