Skip to main content
POST
/
chat-messages
Error
A valid request URL is required to generate request examples
{
  "event": "message",
  "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mode": "chat",
  "answer": "<string>",
  "metadata": {
    "usage": {
      "prompt_tokens": 123,
      "prompt_unit_price": "<string>",
      "prompt_price_unit": "<string>",
      "prompt_price": "<string>",
      "completion_tokens": 123,
      "completion_unit_price": "<string>",
      "completion_price_unit": "<string>",
      "completion_price": "<string>",
      "total_tokens": 123,
      "total_price": "<string>",
      "currency": "<string>",
      "latency": 123
    },
    "retriever_resources": [
      {
        "position": 123,
        "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dataset_name": "<string>",
        "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "document_name": "<string>",
        "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "score": 123,
        "content": "<string>"
      }
    ]
  },
  "created_at": 123
}

Authorizations

​
Authorization
string
header
required

API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。

Body

application/json

发送对话消息的请求体。

​
query
string
required

用户输入/提问内容。

​
user
string
required

用户标识，应用内唯一。重要说明: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。

​
inputs
object

允许传入 App 定义的各变量值。如果变量是文件类型，请指定一个 InputFileObjectCn 对象。

​
response_mode
enum<string>
default:streaming

响应模式。streaming (推荐) 基于 SSE；blocking 等待执行完毕后返回 (Cloudflare 100秒超时限制)。

Available options:
streaming,
blocking
​
conversation_id
string<uuid>

（选填）会话 ID，用于继续之前的对话。

​
files
object[]

（选填）文件列表，仅当模型支持 Vision 能力时可用。

​
auto_generate_name
boolean
default:true

（选填）自动生成会话标题，默认 true。

Response

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

  • 当 response_mode 为 blocking 时，返回 application/json 格式的 ChatCompletionResponseCn 对象。
  • 当 response_mode 为 streaming 时，返回 text/event-stream 格式的 ChunkChatEventCn 对象流式序列。

阻塞模式下的完整 App 结果。

​
event
string

事件类型，固定为 message。

Example:

"message"

​
task_id
string<uuid>

任务 ID。

​
id
string<uuid>

唯一ID。

​
message_id
string<uuid>

消息唯一 ID。

​
conversation_id
string<uuid>

会话 ID。

​
mode
string

App 模式，固定为 chat。

Example:

"chat"

​
answer
string

完整回复内容。

​
metadata
object

元数据。

​
created_at
integer<int64>

消息创建时间戳。