ContextQMD
Back to Dify

工作流编排对话型应用 API

web/app/components/develop/template/template_advanced_chat.zh.mdx

1.14.089.5 KB
Original Source

import { CodeGroup } from '../code.tsx' import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'

工作流编排对话型应用 API

对话应用支持会话持久化，可将之前的聊天记录作为上下文进行回答，可适用于聊天/客服 AI 等。

<div> ### 基础 URL <CodeGroup title="Code" targetCode={props.appDetail.api_base_url} />

鉴权

Service API 使用 API-Key 进行鉴权。 <i>强烈建议开发者把 API-Key 放在后端存储，而非分享或者放在客户端存储，以免 API-Key 泄露，导致财产损失。</i> 所有 API 请求都应在 Authorization HTTP Header 中包含您的 API-Key，如下所示：

<CodeGroup title="Code" targetCode='Authorization: Bearer {API_KEY}' /> </div>

<Heading url='/chat-messages' method='POST' title='发送对话消息' name='#Create-Chat-Message' /> <Row>

<Col> 创建会话消息。 
### Request Body

<Properties>
  <Property name='query' type='string' key='query'>
    用户输入/提问内容。
  </Property>
  <Property name='inputs' type='object' key='inputs'>
    允许传入 App 定义的各变量值。
    inputs 参数包含了多组键值对（Key/Value pairs），每组的键对应一个特定变量，每组的值则是该变量的具体值。
    如果变量是文件类型，请指定一个包含以下 `files` 中所述键的对象。
    默认 `{}`
  </Property>
  <Property name='response_mode' type='string' key='response_mode'>
    - `streaming` 流式模式（推荐）。基于 SSE（**[Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)**）实现类似打字机输出方式的流式返回。
    - `blocking` 阻塞模式，等待执行完毕后返回结果。（请求若流程较长可能会被中断）。
    <i>由于 Cloudflare 限制，请求会在 100 秒超时无返回后中断。</i>
  </Property>
  <Property name='user' type='string' key='user'>
    用户标识，用于定义终端用户的身份，方便检索、统计。
    由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。
  </Property>
  <Property name='conversation_id' type='string' key='conversation_id'>
  （选填）会话 ID，需要基于之前的聊天记录继续对话，必须传之前消息的 conversation_id。
  </Property>
  <Property name='files' type='array[object]' key='files'>
      文件列表，适用于传入文件结合文本理解并回答问题，仅当模型支持 Vision/Video 能力时可用。
      - `type` (string) 支持类型：
        - `document` 具体类型包含：'TXT', 'MD', 'MARKDOWN', 'MDX', 'PDF', 'HTML', 'XLSX', 'XLS', 'VTT', 'PROPERTIES', 'DOC', 'DOCX', 'CSV', 'EML', 'MSG', 'PPTX', 'PPT', 'XML', 'EPUB'
        - `image` 具体类型包含：'JPG', 'JPEG', 'PNG', 'GIF', 'WEBP', 'SVG'
        - `audio` 具体类型包含：'MP3', 'M4A', 'WAV', 'WEBM', 'MPGA'
        - `video` 具体类型包含：'MP4', 'MOV', 'MPEG', 'WEBM'
        - `custom` 具体类型包含：其他文件类型
      - `transfer_method` (string)  传递方式:
        - `remote_url`: 文件地址。
        - `local_file`: 上传文件。
      - `url` 文件地址。（仅当传递方式为 `remote_url` 时）。
      - `upload_file_id` 上传文件 ID。（仅当传递方式为 `local_file `时）。
  </Property>
  <Property name='auto_generate_name' type='bool' key='auto_generate_name'>
  （选填）自动生成标题，默认 `true`。 若设置为 `false`，则可通过调用会话重命名接口并设置 `auto_generate` 为 `true` 实现异步生成标题。
  </Property>
  <Property name='workflow_id' type='string' key='workflow_id'>
  （选填）工作流ID，用于指定特定版本，如果不提供则使用默认的已发布版本。
  </Property>
  <Property name='trace_id' type='string' key='trace_id'>
  （选填）链路追踪ID。适用于与业务系统已有的trace组件打通，实现端到端分布式追踪等场景。如果未指定，系统会自动生成<code>trace_id</code>。支持以下三种方式传递，具体优先级依次为：

    - Header：通过 HTTP Header <code>X-Trace-Id</code> 传递，优先级最高。

    - Query 参数：通过 URL 查询参数 <code>trace_id</code> 传递。

    - Request Body：通过请求体字段 <code>trace_id</code> 传递（即本字段）。

  </Property>
</Properties>

### Response
<Properties>
当 `response_mode` 为 `blocking` 时，返回 ChatCompletionResponse object。
当 `response_mode` 为 `streaming`时，返回 ChunkChatCompletionResponse object 流式序列。

### ChatCompletionResponse

返回完整的 App 结果，`Content-Type` 为 `application/json`。
- `event` (string) 事件类型，固定为 `message`
- `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
- `id` (string) 唯一ID
- `message_id` (string) 消息唯一 ID
- `conversation_id` (string) 会话 ID
- `mode` (string) App 模式，固定为 chat
- `answer` (string) 完整回复内容
- `metadata` (object) 元数据
  - `usage` (Usage) 模型用量信息
  - `retriever_resources` (array[RetrieverResource]) 引用和归属分段列表
- `created_at` (int) 消息创建时间戳，如：1705395332

### ChunkChatCompletionResponse
返回 App 输出的流式块，`Content-Type` 为 `text/event-stream`。
每个流式块均为 data: 开头，块之间以 \n\n 即两个换行符分隔，如下所示：
<CodeGroup>
```streaming {{ title: 'Response' }}
data: {"event": "message", "task_id": "900bbd43-dc0b-4383-a372-aa6e6c414227", "id": "663c5084-a254-4040-8ad3-51f2a3c1a77c", "answer": "Hi", "created_at": 1705398420}\n\n
```
</CodeGroup>

流式块中根据 event 不同，结构也不同：
- `event: message` LLM 返回文本块事件，即：完整的文本以分块的方式输出。
  - `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
  - `message_id` (string) 消息唯一 ID
  - `conversation_id` (string) 会话 ID
  - `answer` (string) LLM 返回文本块内容
  - `created_at` (int) 创建时间戳，如：1705395332
- `event: message_file` 文件事件，表示有新文件需要展示
  - `id` (string) 文件唯一ID
  - `type` (string) 文件类型，目前仅为image
  - `belongs_to` (string) 文件归属，user或assistant，该接口返回仅为 `assistant`
  - `url` (string) 文件访问地址
  - `conversation_id`  (string) 会话ID
- `event: message_end` 消息结束事件，收到此事件则代表流式返回结束。
  - `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
  - `message_id` (string) 消息唯一 ID
  - `conversation_id` (string) 会话 ID
  - `metadata` (object) 元数据
    - `usage` (Usage) 模型用量信息
    - `retriever_resources` (array[RetrieverResource]) 引用和归属分段列表
- `event: tts_message` TTS 音频流事件，即：语音合成输出。内容是Mp3格式的音频块，使用 base64 编码后的字符串，播放的时候直接解码即可。(开启自动播放才有此消息)
  - `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
  - `message_id` (string) 消息唯一 ID
  - `audio` (string) 语音合成之后的音频块使用 Base64 编码之后的文本内容，播放的时候直接 base64 解码送入播放器即可
  - `created_at` (int) 创建时间戳，如：1705395332
- `event: tts_message_end` TTS 音频流结束事件，收到这个事件表示音频流返回结束。
  - `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
  - `message_id` (string) 消息唯一 ID
  - `audio` (string) 结束事件是没有音频的，所以这里是空字符串
  - `created_at` (int) 创建时间戳，如：1705395332
- `event: message_replace` 消息内容替换事件。
  开启内容审查和审查输出内容时，若命中了审查条件，则会通过此事件替换消息内容为预设回复。
  - `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
  - `message_id` (string) 消息唯一 ID
  - `conversation_id` (string) 会话 ID
  - `answer` (string) 替换内容（直接替换 LLM 所有回复文本）
  - `created_at` (int) 创建时间戳，如：1705395332
- `event: workflow_started` workflow 开始执行
  - `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
  - `workflow_run_id` (string) workflow 执行 ID
  - `event` (string) 固定为 `workflow_started`
  - `data` (object) 详细内容
    - `id` (string) workflow 执行 ID
    - `workflow_id` (string) 关联 Workflow ID
    - `created_at` (timestamp) 开始时间
- `event: node_started` node 开始执行
  - `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
  - `workflow_run_id` (string) workflow 执行 ID
  - `event` (string) 固定为 `node_started`
  - `data` (object) 详细内容
    - `id` (string) workflow 执行 ID
    - `node_id` (string) 节点 ID
    - `node_type` (string) 节点类型
    - `title` (string) 节点名称
    - `index` (int) 执行序号，用于展示 Tracing Node 顺序
    - `predecessor_node_id` (string) 前置节点 ID，用于画布展示执行路径
    - `inputs` (object) 节点中所有使用到的前置节点变量内容
    - `created_at` (timestamp) 开始时间
- `event: node_finished` node 执行结束，成功失败同一事件中不同状态
  - `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
  - `workflow_run_id` (string) workflow 执行 ID
  - `event` (string) 固定为 `node_finished`
  - `data` (object) 详细内容
    - `id` (string) node 执行 ID
    - `node_id` (string) 节点 ID
    - `index` (int) 执行序号，用于展示 Tracing Node 顺序
    - `predecessor_node_id` (string) optional 前置节点 ID，用于画布展示执行路径
    - `inputs` (object) 节点中所有使用到的前置节点变量内容
    - `process_data` (json) Optional 节点过程数据
    - `outputs` (json) Optional 输出内容
    - `status` (string) 执行状态 `running` / `succeeded` / `failed` / `stopped`
    - `error` (string) Optional 错误原因
    - `elapsed_time` (float) Optional 耗时(s)
    - `execution_metadata` (json) 元数据
      - `total_tokens` (int) optional 总使用 tokens
      - `total_price` (decimal) optional 总费用
      - `currency` (string) optional 货币，如 `USD` / `RMB`
    - `created_at` (timestamp) 开始时间
- `event: human_input_required` Workflow 已暂停，等待 Human-in-the-Loop 输入
  - `task_id` (string) 任务 ID，用于请求跟踪
  - `workflow_run_id` (string) workflow 执行 ID
  - `event` (string) 固定为 `human_input_required`
  - `data` (object) 详细内容
    - `form_id` (string) 人工输入表单 ID
    - `node_id` (string) Human Input 节点 ID
    - `node_title` (string) Human Input 节点标题
    - `form_content` (string) 渲染后的表单内容
    - `inputs` (array[object]) 表单输入项定义
    - `actions` (array[object]) 用户可选动作按钮
      - `id` (string) 动作 ID
      - `title` (string) 按钮文案
      - `button_style` (string) 按钮样式
    - `display_in_ui` (bool) 是否需要在 UI 展示该表单
    - `form_token` (string) 用于 `/form/human_input/:form_token` 接口的令牌
    - `resolved_default_values` (object) 运行时解析后的默认值
    - `expiration_time` (timestamp) 表单过期时间（Unix 秒级时间戳）
- `event: workflow_finished` workflow 执行结束，成功失败同一事件中不同状态
  - `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
  - `workflow_run_id` (string) workflow 执行 ID
  - `event` (string) 固定为 `workflow_finished`
  - `data` (object) 详细内容
    - `id` (string) workflow 执行 ID
    - `workflow_id` (string) 关联 Workflow ID
    - `status` (string)  执行状态 `running` / `succeeded` / `failed` / `stopped`
    - `outputs` (json) Optional 输出内容
    - `error` (string) Optional 错误原因
    - `elapsed_time` (float) Optional 耗时(s)
    - `total_tokens` (int) Optional 总使用 tokens
    - `total_steps` (int) 总步数（冗余），默认 0
    - `created_at` (timestamp) 开始时间
    - `finished_at` (timestamp) 结束时间
- `event: error`
  流式输出过程中出现的异常会以 stream event 形式输出，收到异常事件后即结束。
  - `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
  - `message_id` (string) 消息唯一 ID
  - `status` (int) HTTP 状态码
  - `code` (string) 错误码
  - `message` (string) 错误消息
- `event: ping` 每 10s 一次的 ping 事件，保持连接存活。

### Errors
- 404，对话不存在
- 400，`invalid_param`，传入参数异常
- 400，`app_unavailable`，App 配置不可用
- 400，`provider_not_initialize`，无可用模型凭据配置
- 400，`provider_quota_exceeded`，模型调用额度不足
- 400，`model_currently_not_support`，当前模型不可用
- 400，`workflow_not_found`，指定的工作流版本未找到
- 400，`draft_workflow_error`，无法使用草稿工作流版本
- 400，`workflow_id_format_error`，工作流ID格式错误，需要UUID格式
- 400，`completion_request_error`，文本生成失败
- 500，服务内部异常

</Properties>
</Col> <Col sticky> 
<CodeGroup
  title="Request"
  tag="POST"
  label="/chat-messages"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/chat-messages' \\

--header 'Authorization: Bearer {api_key}' \ --header 'Content-Type: application/json' \ --data-raw '{ "inputs": ${JSON.stringify(props.inputs)}, "query": "What are the specs of the iPhone 13 Pro Max?", "response_mode": "streaming", "conversation_id": "", "user": "abc-123", "files": [ { "type": "image", "transfer_method": "remote_url", "url": "https://cloud.dify.ai/logo/logo-site.png" } ] }'`} /> ### 阻塞模式 阻塞模式可能返回普通聊天响应，也可能返回暂停中的工作流响应。

当 Advanced Chat 因 Human-in-the-Loop 暂停时，`event` 会变为 `workflow_paused`。
响应仍然包含 `message_id`、`conversation_id`、`answer` 和 `workflow_run_id`，并且 `data` 中会新增 `paused_nodes` 和 `reasons`。
对于 `human_input_required`，每个 reason 都会包含 `form_id` 和 `expiration_time`。

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
    "event": "message",
    "task_id": "c3800678-a077-43df-a102-53f23ed20b88",
    "id": "9da23599-e713-473b-982c-4328d4f5c78a",
    "message_id": "9da23599-e713-473b-982c-4328d4f5c78a",
    "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2",
    "mode": "chat",
    "answer": "iPhone 13 Pro Max specs are listed here:...",
    "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
        },
        "retriever_resources": [
            {
                "position": 1,
                "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb",
                "dataset_name": "iPhone",
                "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00",
                "document_name": "iPhone List",
                "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a",
                "score": 0.98457545,
                "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"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\""
            }
        ]
    },
    "created_at": 1705407629
}
```
</CodeGroup>
<CodeGroup title="Paused Response Example">
```json {{ title: 'Paused Response Example' }}
{
    "event": "workflow_paused",
    "task_id": "8a9cbfcf-e7e0-4b17-aeef-24de57a2659a",
    "id": "31714374-88cb-485f-9fa4-e3ab2a9ed95e",
    "message_id": "31714374-88cb-485f-9fa4-e3ab2a9ed95e",
    "conversation_id": "098e19be-356a-435d-9ec3-a406f4f1a97a",
    "mode": "advanced-chat",
    "answer": "",
    "metadata": {
        "annotation_reply": null,
        "retriever_resources": [],
        "usage": null
    },
    "created_at": 1776074715,
    "workflow_run_id": "7a4d6509-8a65-4c7d-a4fd-cf081dcf169f",
    "data": {
        "id": "31714374-88cb-485f-9fa4-e3ab2a9ed95e",
        "mode": "advanced-chat",
        "conversation_id": "098e19be-356a-435d-9ec3-a406f4f1a97a",
        "message_id": "31714374-88cb-485f-9fa4-e3ab2a9ed95e",
        "workflow_run_id": "7a4d6509-8a65-4c7d-a4fd-cf081dcf169f",
        "answer": "",
        "metadata": {
            "annotation_reply": null,
            "retriever_resources": [],
            "usage": null
        },
        "created_at": 1776074715,
        "paused_nodes": [
            "1775724080699"
        ],
        "reasons": [
            {
                "form_id": "019d864d-6f55-752c-9f4c-feee67508d5b",
                "form_content": "this is form 2:\n\n{{#$output.some_field_2#}}\n",
                "inputs": [
                    {
                        "type": "paragraph",
                        "output_variable_name": "some_field_2",
                        "default": {
                            "type": "constant",
                            "selector": [],
                            "value": ""
                        }
                    }
                ],
                "actions": [
                    {
                        "id": "approve",
                        "title": "yes",
                        "button_style": "default"
                    },
                    {
                        "id": "reject",
                        "title": "no",
                        "button_style": "default"
                    }
                ],
                "display_in_ui": true,
                "node_id": "1775724080699",
                "node_title": "Human Input 2",
                "resolved_default_values": {},
                "form_token": "0dvwTdpTFXgCZmAo2FoiJ5",
                "type": "human_input_required",
                "expiration_time": 1776333914
            }
        ],
        "status": "paused",
        "elapsed_time": 0.034081,
        "total_tokens": 0,
        "total_steps": 2
    }
}
```
</CodeGroup>
### 流式模式
<CodeGroup title="Response">
```streaming {{ title: 'Response' }}
  data: {"event": "workflow_started", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "workflow_id": "dfjasklfjdslag", "created_at": 1679586595}}
  data: {"event": "node_started", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "node_id": "dfjasklfjdslag", "node_type": "start", "title": "Start", "index": 0, "predecessor_node_id": "fdljewklfklgejlglsd", "inputs": {}, "created_at": 1679586595}}
  data: {"event": "node_finished", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "node_id": "dfjasklfjdslag", "node_type": "start", "title": "Start", "index": 0, "predecessor_node_id": "fdljewklfklgejlglsd", "inputs": {}, "outputs": {}, "status": "succeeded", "elapsed_time": 0.324, "execution_metadata": {"total_tokens": 63127864, "total_price": 2.378, "currency": "USD"},  "created_at": 1679586595}}
  data: {"event": "workflow_finished", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "workflow_id": "dfjasklfjdslag", "outputs": {}, "status": "succeeded", "elapsed_time": 0.324, "total_tokens": 63127864, "total_steps": "1", "created_at": 1679586595, "finished_at": 1679976595}}
  data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " I", "created_at": 1679586595}
  data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": "'m", "created_at": 1679586595}
  data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " glad", "created_at": 1679586595}
  data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " to", "created_at": 1679586595}
  data: {"event": "message", "message_id" : "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " meet", "created_at": 1679586595}
  data: {"event": "message", "message_id" : "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " you", "created_at": 1679586595}
  data: {"event": "message_end", "id": "5e52ce04-874b-4d27-9045-b3bc80def685", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "metadata": {"usage": {"prompt_tokens": 1033, "prompt_unit_price": "0.001", "prompt_price_unit": "0.001", "prompt_price": "0.0010330", "completion_tokens": 135, "completion_unit_price": "0.002", "completion_price_unit": "0.001", "completion_price": "0.0002700", "total_tokens": 1168, "total_price": "0.0013030", "currency": "USD", "latency": 1.381760165997548}, "retriever_resources": [{"position": 1, "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb", "dataset_name": "iPhone", "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00", "document_name": "iPhone List", "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a", "score": 0.98457545, "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"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\""}]}}
  data: {"event": "tts_message", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": "qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq"}
  data: {"event": "tts_message_end", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": ""}
```
</CodeGroup>
流式模式同样可能因为 Human-in-the-Loop 而暂停。此时 SSE 流会先返回 `human_input_required`，随后返回 `workflow_paused`。

<CodeGroup title="Paused Streaming Response Example">
```streaming {{ title: 'Paused Streaming Response Example' }}
event: ping

data: {
  "event": "workflow_started",
  "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
  "task_id": "0399c5c2-181b-4493-a78e-1421914e8a25",
  "data": {
    "id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
    "workflow_id": "e46514f1-c008-41ff-94b0-4f33d4b97d36",
    "inputs": {
      "sys.files": [],
      "sys.user_id": "abc-123",
      "sys.app_id": "d1074979-f67e-4114-8691-e35878df9a89",
      "sys.workflow_id": "e46514f1-c008-41ff-94b0-4f33d4b97d36",
      "sys.workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345"
    },
    "created_at": 1776129228,
    "reason": "initial"
  }
}

data: {
  "event": "node_started",
  "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
  "task_id": "0399c5c2-181b-4493-a78e-1421914e8a25",
  "data": {
    "id": "7d9bb041-5ecb-497f-a674-d8706eed0ab1",
    "node_id": "1775717266623",
    "node_type": "start",
    "title": "User Input",
    "index": 1,
    "predecessor_node_id": null,
    "inputs": null,
    "inputs_truncated": false,
    "created_at": 1776129228,
    "extras": {},
    "iteration_id": null,
    "loop_id": null,
    "agent_strategy": null
  }
}

data: {
  "event": "node_finished",
  "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
  "task_id": "0399c5c2-181b-4493-a78e-1421914e8a25",
  "data": {
    "id": "7d9bb041-5ecb-497f-a674-d8706eed0ab1",
    "node_id": "1775717266623",
    "node_type": "start",
    "title": "User Input",
    "index": 1,
    "predecessor_node_id": null,
    "inputs": {
      "sys.files": [],
      "sys.user_id": "abc-123",
      "sys.app_id": "d1074979-f67e-4114-8691-e35878df9a89",
      "sys.workflow_id": "e46514f1-c008-41ff-94b0-4f33d4b97d36",
      "sys.workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
      "sys.timestamp": 1776129228
    },
    "inputs_truncated": false,
    "process_data": {},
    "process_data_truncated": false,
    "outputs": {
      "sys.files": [],
      "sys.user_id": "abc-123",
      "sys.app_id": "d1074979-f67e-4114-8691-e35878df9a89",
      "sys.workflow_id": "e46514f1-c008-41ff-94b0-4f33d4b97d36",
      "sys.workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
      "sys.timestamp": 1776129228
    },
    "outputs_truncated": false,
    "status": "succeeded",
    "error": null,
    "elapsed_time": 0.000097,
    "execution_metadata": null,
    "created_at": 1776129228,
    "finished_at": 1776129228,
    "files": [],
    "iteration_id": null,
    "loop_id": null
  }
}

data: {
  "event": "node_started",
  "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
  "task_id": "0399c5c2-181b-4493-a78e-1421914e8a25",
  "data": {
    "id": "c09ff568-1d55-4f0d-9a07-512bcbfeb289",
    "node_id": "1775717346519",
    "node_type": "human-input",
    "title": "Human Input",
    "index": 1,
    "predecessor_node_id": null,
    "inputs": null,
    "inputs_truncated": false,
    "created_at": 1776129228,
    "extras": {},
    "iteration_id": null,
    "loop_id": null,
    "agent_strategy": null
  }
}

data: {
  "event": "human_input_required",
  "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
  "task_id": "0399c5c2-181b-4493-a78e-1421914e8a25",
  "data": {
    "form_id": "019d898d-3d80-7105-b920-9899ead4ff3e",
    "node_id": "1775717346519",
    "node_title": "Human Input",
    "form_content": "this is form 1:\n{{#$output.some_field#}}\n",
    "inputs": [
      {
        "type": "paragraph",
        "output_variable_name": "some_field",
        "default": {
          "type": "variable",
          "selector": [
            "sys",
            "workflow_run_id"
          ],
          "value": ""
        }
      }
    ],
    "actions": [
      {
        "id": "approve",
        "title": "YES",
        "button_style": "default"
      },
      {
        "id": "reject",
        "title": "NO",
        "button_style": "default"
      }
    ],
    "display_in_ui": true,
    "form_token": "0Tb1nXYe4hzQUD706nHB4y",
    "resolved_default_values": {
      "some_field": "a4959eb4-c852-4e0c-ac7a-348233f7f345"
    },
    "expiration_time": 1776388428
  }
}

data: {
  "event": "workflow_paused",
  "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
  "task_id": "0399c5c2-181b-4493-a78e-1421914e8a25",
  "data": {
    "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
    "paused_nodes": [
      "1775717346519"
    ],
    "outputs": {},
    "reasons": [
      {
        "form_id": "019d898d-3d80-7105-b920-9899ead4ff3e",
        "form_content": "this is form 1:\n{{#$output.some_field#}}\n",
        "inputs": [
          {
            "type": "paragraph",
            "output_variable_name": "some_field",
            "default": {
              "type": "variable",
              "selector": [
                "sys",
                "workflow_run_id"
              ],
              "value": ""
            }
          }
        ],
        "actions": [
          {
            "id": "approve",
            "title": "YES",
            "button_style": "default"
          },
          {
            "id": "reject",
            "title": "NO",
            "button_style": "default"
          }
        ],
        "display_in_ui": true,
        "node_id": "1775717346519",
        "node_title": "Human Input",
        "resolved_default_values": {
          "some_field": "a4959eb4-c852-4e0c-ac7a-348233f7f345"
        },
        "form_token": "0Tb1nXYe4hzQUD706nHB4y",
        "type": "human_input_required",
        "expiration_time": 1776388428
      }
    ],
    "status": "paused",
    "created_at": 1776129228,
    "elapsed_time": 0.070478,
    "total_tokens": 0,
    "total_steps": 2
  }
}
```
</CodeGroup>
</Col> </Row>

<Heading url='/files/upload' method='POST' title='上传文件' name='#files-upload' /> <Row>

<Col> 上传文件并在发送消息时使用，可实现图文多模态理解。 支持您的应用程序所支持的所有格式。 <i>上传的文件仅供当前终端用户使用。</i> 
### Request Body
该接口需使用  `multipart/form-data` 进行请求。
<Properties>
  <Property name='file' type='file' key='file'>
    要上传的文件。
  </Property>
  <Property name='user' type='string' key='user'>
      用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。
  </Property>
</Properties>

### Response
成功上传后，服务器会返回文件的 ID 和相关信息。
- `id` (uuid) ID
- `name` (string) 文件名
- `size` (int) 文件大小（byte）
- `extension` (string) 文件后缀
- `mime_type` (string) 文件 mime-type
- `created_by` (uuid) 上传人 ID
- `created_at` (timestamp) 上传时间

### Errors
- 400，`no_file_uploaded`，必须提供文件
- 400，`too_many_files`，目前只接受一个文件
- 400，`unsupported_preview`，该文件不支持预览
- 400，`unsupported_estimate`，该文件不支持估算
- 413，`file_too_large`，文件太大
- 415，`unsupported_file_type`，不支持的扩展名，当前只接受文档类文件
- 503，`s3_connection_failed`，无法连接到 S3 服务
- 503，`s3_permission_denied`，无权限上传文件到 S3
- 503，`s3_file_too_large`，文件超出 S3 大小限制
</Col> <Col sticky> 
<CodeGroup
title="Request"
tag="POST"
label="/files/upload"
targetCode={`curl -X POST '${props.appDetail.api_base_url}/files/upload' \\

--header 'Authorization: Bearer {api_key}' \ --form 'file=@localfile;type=image/[png|jpeg|jpg|webp|gif]' \ --form 'user=abc-123'`} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "id": "72fa9618-8f89-4a37-9b33-7e1178a24a67",
  "name": "example.png",
  "size": 1024,
  "extension": "png",
  "mime_type": "image/png",
  "created_by": 123,
  "created_at": 1577836800,
}
```
</CodeGroup>
</Col> </Row> ---

<Heading url='/end-users/:end_user_id' method='GET' title='获取终端用户' name='#end-user' /> <Row>

<Col> 通过终端用户 ID 获取终端用户信息。 
当其他 API 返回终端用户 ID（例如：上传文件接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。

### 路径参数
- `end_user_id` (uuid) 必需
  终端用户 ID。

### Response
返回 EndUser 对象。
- `id` (uuid) ID
- `tenant_id` (uuid) 工作空间（Tenant）ID
- `app_id` (uuid) 应用 ID
- `type` (string) 终端用户类型
- `external_user_id` (string) 外部用户 ID
- `name` (string) 名称
- `is_anonymous` (boolean) 是否匿名
- `session_id` (string) 会话 ID
- `created_at` (string) ISO 8601 时间
- `updated_at` (string) ISO 8601 时间

### Errors
- 404，`end_user_not_found`，终端用户不存在
- 500，内部服务器错误
</Col> <Col sticky> <CodeGroup title="Request" tag="GET" label="/end-users/:end_user_id" targetCode={`curl -X GET '${props.appDetail.api_base_url}/end-users/6ad1ab0a-73ff-4ac1-b9e4-cdb312f71f13' \\ --header 'Authorization: Bearer {api_key}'`} /> 
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "id": "6ad1ab0a-73ff-4ac1-b9e4-cdb312f71f13",
  "tenant_id": "8c0f3f3a-66b0-4b55-a0bf-8b8e0d6aee7d",
  "app_id": "6c8c3f41-2c6f-4e1b-8f4f-7f11c8f2ad2a",
  "type": "service_api",
  "external_user_id": "abc-123",
  "name": "Alice",
  "is_anonymous": false,
  "session_id": "abc-123",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}
```
</CodeGroup>
</Col> </Row> ---

<Heading url='/files/:file_id/preview' method='GET' title='文件预览' name='#file-preview' /> <Row>

<Col> 预览或下载已上传的文件。此端点允许您访问先前通过文件上传 API 上传的文件。 
<i>文件只能在属于请求应用程序的消息范围内访问。</i>

### 路径参数
- `file_id` (string) 必需
  要预览的文件的唯一标识符，从文件上传 API 响应中获得。

### 查询参数
- `as_attachment` (boolean) 可选
  是否强制将文件作为附件下载。默认为 `false`（在浏览器中预览）。

### 响应
返回带有适当浏览器显示或下载标头的文件内容。
- `Content-Type` 根据文件 MIME 类型设置
- `Content-Length` 文件大小（以字节为单位，如果可用）
- `Content-Disposition` 如果 `as_attachment=true` 则设置为 "attachment"
- `Cache-Control` 用于性能的缓存标头
- `Accept-Ranges` 对于音频/视频文件设置为 "bytes"

### 错误
- 400, `invalid_param`, 参数输入异常
- 403, `file_access_denied`, 文件访问被拒绝或文件不属于当前应用程序
- 404, `file_not_found`, 文件未找到或已被删除
- 500, 服务内部错误
</Col> <Col sticky> ### 请求示例 <CodeGroup title="Request" tag="GET" label="/files/:file_id/preview" targetCode={`curl -X GET '${props.appDetail.api_base_url}/files/72fa9618-8f89-4a37-9b33-7e1178a24a67/preview' \\ --header 'Authorization: Bearer {api_key}'`} /> 
### 作为附件下载
<CodeGroup
  title="Download Request"
  tag="GET"
  label="/files/:file_id/preview?as_attachment=true"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/files/72fa9618-8f89-4a37-9b33-7e1178a24a67/preview?as_attachment=true' \\

--header 'Authorization: Bearer {api_key}' \ --output downloaded_file.png`} />

### 响应标头示例
<CodeGroup title="Response Headers">
```http {{ title: 'Headers - 图片预览' }}
Content-Type: image/png
Content-Length: 1024
Cache-Control: public, max-age=3600
```
</CodeGroup>

### 文件下载响应标头
<CodeGroup title="Download Response Headers">
```http {{ title: 'Headers - 文件下载' }}
Content-Type: image/png
Content-Length: 1024
Content-Disposition: attachment; filename*=UTF-8''example.png
Cache-Control: public, max-age=3600
```
</CodeGroup>
</Col> </Row> ---

<Heading url='/chat-messages/:task_id/stop' method='POST' title='停止响应' name='#Stop' /> <Row>

<Col> 仅支持流式模式。 ### Path - `task_id` (string) 任务 ID，可在流式返回 Chunk 中获取

Request Body

  • user (string) Required 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。API 无法访问 WebApp 创建的会话。

Response

  • result (string) 固定返回 success
</Col> <Col sticky> <CodeGroup title="Request" tag="POST" label="/chat-messages/:task_id/stop" targetCode={`curl -X POST '${props.appDetail.api_base_url}/chat-messages/:task_id/stop' \\ -H 'Authorization: Bearer {api_key}' \\ -H 'Content-Type: application/json' \\ --data-raw '{ "user": "abc-123" }'`} /> 
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "result": "success"
}
```
</CodeGroup>
</Col> </Row> ---

<Heading url='/form/human_input/:form_token' method='GET' title='获取人工输入表单' name='#get-human-input-form' /> <Row>

<Col> 通过 `form_token` 获取待处理的 Human-in-the-Loop 表单。 
当流式事件返回 `human_input_required`（包含 `form_token`）时，可调用此接口拉取表单详情。

### Path
- `form_token` (string) 必填，暂停事件返回的表单 token

### Response
- `form_content` (string) 已渲染的表单内容（markdown/plain text）
- `inputs` (array[object]) 表单输入项定义
- `resolved_default_values` (object) 已解析的默认值（字符串）
- `user_actions` (array[object]) 操作按钮列表
- `expiration_time` (timestamp) 表单过期时间（Unix 秒）

### Errors
- 404，表单不存在或不属于当前应用
- 412，`human_input_form_submitted`，表单已被提交
- 412，`human_input_form_expired`，表单已过期
</Col> <Col sticky> <CodeGroup title="Request" tag="GET" label="/form/human_input/:form_token" targetCode={`curl -X GET '${props.appDetail.api_base_url}/form/human_input/{form_token}' \\ --header 'Authorization: Bearer {api_key}'`} /> 
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "form_content": "请确认最终结果：{{#$output.answer#}}",
  "inputs": [
    {
      "label": "答案",
      "type": "text-input",
      "required": true,
      "output_variable_name": "answer"
    }
  ],
  "resolved_default_values": {
    "answer": "初始值"
  },
  "user_actions": [
    { "id": "approve", "title": "通过", "button_style": "primary" },
    { "id": "reject", "title": "拒绝", "button_style": "warning" }
  ],
  "expiration_time": 1735689600
}
```
</CodeGroup>
</Col> </Row>

<Heading url='/form/human_input/:form_token' method='POST' title='提交人工输入表单' name='#submit-human-input-form' /> <Row>

<Col> 提交待处理的 Human-in-the-Loop 表单。 
### Path
- `form_token` (string) 必填，暂停事件返回的表单 token

### Request Body
- `inputs` (object) 必填，表单字段的 key/value
- `action` (string) 必填，从 `user_actions` 中选择的动作 ID
- `user` (string) 必填，终端用户标识

### Response
成功时返回空对象。

### Errors
- 400，`invalid_form_data`，提交数据与表单 schema 不匹配
- 404，表单不存在或不属于当前应用
- 412，`human_input_form_submitted`，表单已被提交
- 412，`human_input_form_expired`，表单已过期
</Col> <Col sticky> <CodeGroup title="Request" tag="POST" label="/form/human_input/:form_token" targetCode={`curl -X POST '${props.appDetail.api_base_url}/form/human_input/{form_token}' \\ --header 'Authorization: Bearer {api_key}' \\ --header 'Content-Type: application/json' \\ --data-raw '{ "inputs": {"answer": "已确认答案"}, "action": "approve", "user": "abc-123" }'`} /> 
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{}
```
</CodeGroup>
</Col> </Row>

<Heading url='/workflow/:task_id/events' method='GET' title='获取恢复后的 Workflow 事件流' name='#get-workflow-resume-events' /> <Row>

<Col> 在提交人工输入表单后，继续订阅工作流后续执行事件。 
返回 `text/event-stream`，可持续接收直到工作流结束。

### Path
- `task_id` (string) 必填，workflow 运行 ID（`workflow_run_id`）

### Query
- `user` (string) 必填，终端用户标识
- `include_state_snapshot` (bool) 可选，设为 `true` 时会先回放持久化状态快照，再继续实时事件
- `continue_on_pause` (bool) 可选，设为 `true` 时，流会在 `workflow_paused` 事件之间保持连接，直到 `workflow_finished` 才结束

### Response
Server-Sent Events 流（`text/event-stream`）。
常见事件包括 `workflow_paused`、`node_started`、`node_finished`、`human_input_form_filled`、`human_input_form_timeout`、`workflow_finished`。
如果调用该接口时工作流已经结束，服务端会立即返回单个完成事件。
</Col> <Col sticky> <CodeGroup title="Request" tag="GET" label="/workflow/:task_id/events" targetCode={`curl -N -X GET '${props.appDetail.api_base_url}/workflow/{workflow_run_id}/events?user=abc-123&continue_on_pause=true' \\ --header 'Authorization: Bearer {api_key}'`} /> 
<CodeGroup title="Response">
```streaming {{ title: 'Response' }}
event: ping

data: {"event":"workflow_started","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","data":{"id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","workflow_id":"e46514f1-c008-41ff-94b0-4f33d4b97d36","inputs":{"sys.files":[],"sys.user_id":"abc-123","sys.app_id":"d1074979-f67e-4114-8691-e35878df9a89","sys.workflow_id":"e46514f1-c008-41ff-94b0-4f33d4b97d36","sys.workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","sys.timestamp":1776087863},"created_at":1776087863,"reason":"initial"}}

data: {"event":"node_started","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","data":{"id":"b552d685-1119-4e6a-9a81-e91a23e5324b","node_id":"1775717266623","node_type":"start","title":"User Input","index":1,"predecessor_node_id":null,"inputs":null,"created_at":1776087863,"extras":{},"iteration_id":null,"loop_id":null}}

data: {"event":"node_finished","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","data":{"id":"b552d685-1119-4e6a-9a81-e91a23e5324b","node_id":"1775717266623","node_type":"start","title":"User Input","index":1,"predecessor_node_id":null,"inputs":null,"process_data":null,"outputs":null,"status":"succeeded","error":null,"elapsed_time":0.00032,"execution_metadata":null,"created_at":1776087863,"finished_at":1776087863,"files":[],"iteration_id":null,"loop_id":null}}

data: {"event":"node_started","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","data":{"id":"8d7e8e01-5159-4089-a4b6-3aa394992cc2","node_id":"1775717346519","node_type":"human-input","title":"Human Input","index":2,"predecessor_node_id":null,"inputs":null,"created_at":1776087863,"extras":{},"iteration_id":null,"loop_id":null}}

data: {"event":"node_finished","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","data":{"id":"8d7e8e01-5159-4089-a4b6-3aa394992cc2","node_id":"1775717346519","node_type":"human-input","title":"Human Input","index":2,"predecessor_node_id":null,"inputs":null,"process_data":null,"outputs":null,"status":"paused","error":null,"elapsed_time":0.007381,"execution_metadata":null,"created_at":1776087863,"finished_at":1776087863,"files":[],"iteration_id":null,"loop_id":null}}

data: {"event":"workflow_paused","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","data":{"workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","paused_nodes":["1775717346519"],"outputs":{},"reasons":[{"form_id":"019d8716-0fde-75da-8207-1458ccde76e5","form_content":"this is form 1:\n{{#$output.some_field#}}\n","inputs":[{"type":"paragraph","output_variable_name":"some_field","default":{"type":"variable","selector":["sys","workflow_run_id"],"value":""}}],"actions":[{"id":"approve","title":"YES","button_style":"default"},{"id":"reject","title":"NO","button_style":"default"}],"display_in_ui":true,"node_id":"1775717346519","node_title":"Human Input","resolved_default_values":{"some_field":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c"},"form_token":"n7hFG4ZDYdGcgZ5VDc7EGM","type":"human_input_required"}],"status":"paused","created_at":1776087863,"elapsed_time":0.0,"total_tokens":0,"total_steps":2}}

data: {"event":"workflow_started","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","workflow_id":"e46514f1-c008-41ff-94b0-4f33d4b97d36","inputs":{"sys.files":[],"sys.user_id":"abc-123","sys.app_id":"d1074979-f67e-4114-8691-e35878df9a89","sys.workflow_id":"e46514f1-c008-41ff-94b0-4f33d4b97d36","sys.workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c"},"created_at":1776087877,"reason":"resumption"}}

data: {"event":"node_started","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"8d7e8e01-5159-4089-a4b6-3aa394992cc2","node_id":"1775717346519","node_type":"human-input","title":"Human Input","index":1,"predecessor_node_id":null,"inputs":null,"inputs_truncated":false,"created_at":1776087877,"extras":{},"iteration_id":null,"loop_id":null,"agent_strategy":null}}

data: {"event":"human_input_form_filled","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"node_id":"1775717346519","node_title":"Human Input","rendered_content":"this is form 1:\nfield 1 filled!\n","action_id":"approve","action_text":"YES"}}

data: {"event":"node_finished","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"8d7e8e01-5159-4089-a4b6-3aa394992cc2","node_id":"1775717346519","node_type":"human-input","title":"Human Input","index":1,"predecessor_node_id":null,"inputs":{},"inputs_truncated":false,"process_data":{},"process_data_truncated":false,"outputs":{"some_field":"field 1 filled!","some_field_2":"from bruno with love","__action_id":"approve","__rendered_content":"this is form 1:\nfield 1 filled!\n"},"outputs_truncated":false,"status":"succeeded","error":null,"elapsed_time":0.004431,"execution_metadata":null,"created_at":1776087877,"finished_at":1776087877,"files":[],"iteration_id":null,"loop_id":null}}

data: {"event":"node_started","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"6d8fc3cb-19f7-440b-b83e-eed4e847a332","node_id":"1775717350710","node_type":"template-transform","title":"Template","index":1,"predecessor_node_id":null,"inputs":null,"inputs_truncated":false,"created_at":1776087877,"extras":{},"iteration_id":null,"loop_id":null,"agent_strategy":null}}

data: {"event":"text_chunk","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"text":"field 1 filled!","from_variable_selector":["1775717350710","output"]}}

data: {"event":"node_finished","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"6d8fc3cb-19f7-440b-b83e-eed4e847a332","node_id":"1775717350710","node_type":"template-transform","title":"Template","index":1,"predecessor_node_id":null,"inputs":{"some_field":"field 1 filled!"},"inputs_truncated":false,"process_data":{},"process_data_truncated":false,"outputs":{"output":"field 1 filled!"},"outputs_truncated":false,"status":"succeeded","error":null,"elapsed_time":0.264614,"execution_metadata":null,"created_at":1776087877,"finished_at":1776087877,"files":[],"iteration_id":null,"loop_id":null}}

data: {"event":"node_started","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"e88dec7e-aa2c-41f7-8d73-032b749e23f5","node_id":"1775717354177","node_type":"end","title":"Output","index":1,"predecessor_node_id":null,"inputs":null,"inputs_truncated":false,"created_at":1776087877,"extras":{},"iteration_id":null,"loop_id":null,"agent_strategy":null}}

data: {"event":"node_finished","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"e88dec7e-aa2c-41f7-8d73-032b749e23f5","node_id":"1775717354177","node_type":"end","title":"Output","index":1,"predecessor_node_id":null,"inputs":{"output":"field 1 filled!"},"inputs_truncated":false,"process_data":{},"process_data_truncated":false,"outputs":{"output":"field 1 filled!"},"outputs_truncated":false,"status":"succeeded","error":null,"elapsed_time":0.00003,"execution_metadata":null,"created_at":1776087877,"finished_at":1776087877,"files":[],"iteration_id":null,"loop_id":null}}

data: {"event":"workflow_finished","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","workflow_id":"e46514f1-c008-41ff-94b0-4f33d4b97d36","status":"succeeded","outputs":{"output":"field 1 filled!"},"error":null,"elapsed_time":0.364935,"total_tokens":0,"total_steps":5,"created_by":{"id":"7932d34c-dcf4-4fba-b770-f2a9de88c0a0","user":"abc-123"},"created_at":1776087877,"finished_at":1776087877,"exceptions_count":0,"files":[]}}
```
</CodeGroup>
</Col> </Row>

<Heading url='/messages/:message_id/feedbacks' method='POST' title='消息反馈（点赞）' name='#feedbacks' /> <Row>

<Col> 消息终端用户反馈、点赞，方便应用开发者优化输出预期。 
### Path Params
<Properties>
  <Property name='message_id' type='string' key='message_id'>
   消息 ID
  </Property>
</Properties>

### Request Body

<Properties>
  <Property name='rating' type='string' key='rating'>
     点赞 like, 点踩 dislike,  撤销点赞 null
  </Property>
  <Property name='user' type='string' key='user'>
      用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
  </Property>
  <Property name='content' type='string' key='content'>
      消息反馈的具体信息。
  </Property>
</Properties>

### Response
- `result` (string) 固定返回 success
</Col> <Col sticky> 
<CodeGroup
  title="Request"
  tag="POST"
  label="/messages/:message_id/feedbacks"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/messages/:message_id/feedbacks' \\

--header 'Authorization: Bearer {api_key}' \ --header 'Content-Type: application/json' \ --data-raw '{ "rating": "like", "user": "abc-123", "content": "message feedback information" }'`} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "result": "success"
}
```
</CodeGroup>
</Col> </Row>

<Heading url='/app/feedbacks' method='GET' title='获取APP的消息点赞和反馈' name='#app-feedbacks' /> <Row>

<Col> 获取应用的终端用户反馈、点赞。 
### Query
<Properties>
  <Property name='page' type='string' key='page'>
   （选填）分页，默认值：1
  </Property>
</Properties>

<Properties>
  <Property name='limit' type='string' key='limit'>
   （选填）每页数量，默认值：20
  </Property>
</Properties>

### Response
- `data` (List) 返回该APP的点赞、反馈列表。
</Col> <Col sticky> 
<CodeGroup
  title="Request"
  tag="GET"
  label="/app/feedbacks"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/app/feedbacks?page=1&limit=20' \\

--header 'Authorization: Bearer {api_key}' \ --header 'Content-Type: application/json'`} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
    {
    "data": [
        {
            "id": "8c0fbed8-e2f9-49ff-9f0e-15a35bdd0e25",
            "app_id": "f252d396-fe48-450e-94ec-e184218e7346",
            "conversation_id": "2397604b-9deb-430e-b285-4726e51fd62d",
            "message_id": "709c0b0f-0a96-4a4e-91a4-ec0889937b11",
            "rating": "like",
            "content": "message feedback information-3",
            "from_source": "user",
            "from_end_user_id": "74286412-9a1a-42c1-929c-01edb1d381d5",
            "from_account_id": null,
            "created_at": "2025-04-24T09:24:38",
            "updated_at": "2025-04-24T09:24:38"
        }
    ]
    }

```
</CodeGroup>
</Col> </Row>

<Heading url='/messages/{message_id}/suggested' method='GET' title='获取下一轮建议问题列表' name='#suggested' /> <Row>

<Col> 获取下一轮建议问题列表。 
### Path Params

<Properties>
  <Property name='message_id' type='string' key='message_id'>
    Message ID
  </Property>
</Properties>

### Query
<Properties>
  <Property name='user' type='string' key='user'>
    用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
  </Property>
</Properties>
</Col> <Col sticky> 
<CodeGroup
  title="Request"
  tag="GET"
  label="/messages/{message_id}/suggested"
  targetCode={`curl --location --request GET '${props.appDetail.api_base_url}/messages/{message_id}/suggested?user=abc-123' \\

--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \ --header 'Content-Type: application/json'`} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "result": "success",
  "data": [
        "a",
        "b",
        "c"
    ]
}
```
</CodeGroup>
</Col> </Row>

<Heading url='/messages' method='GET' title='获取会话历史消息' name='#messages' /> <Row>

<Col> 滚动加载形式返回历史聊天记录，第一页返回最新 `limit` 条，即：倒序返回。 
### Query

<Properties>
  <Property name='conversation_id' type='string' key='conversation_id'>
    会话 ID
  </Property>
  <Property name='user' type='string' key='user'>
    用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
  </Property>
  <Property name='first_id' type='string' key='first_id'>
    当前页第一条聊天记录的 ID，默认 null
  </Property>
  <Property name='limit' type='int' key='limit'>
    一次请求返回多少条聊天记录，默认 20 条。
  </Property>
</Properties>

### Response
- `data` (array[object])  消息列表
  - `id`  (string) 消息 ID
  - `conversation_id` (string)  会话 ID
  - `inputs` (object) 用户输入参数。
  - `query`  (string) 用户输入 / 提问内容。
  - `message_files` (array[object]) 消息文件
    - `id` (string) ID
    - `type` (string) 文件类型，image 图片
    - `url` (string) 文件预览地址，使用文件预览 API (`/files/{file_id}/preview`) 访问文件
    - `belongs_to` (string) 文件归属方，user 或 assistant
  - `answer` (string)  回答消息内容
  - `created_at`  (timestamp) 创建时间
  - `feedback` (object) 反馈信息
    - `rating` (string) 点赞 like / 点踩 dislike
  - `retriever_resources` (array[RetrieverResource]) 引用和归属分段列表
- `has_more` (bool) 是否存在下一页
- `limit` (int) 返回条数，若传入超过系统限制，返回系统限制数量
</Col> <Col sticky> ### Request Example <CodeGroup title="Request" tag="GET" label="/messages" targetCode={`curl -X GET '${props.appDetail.api_base_url}/messages?user=abc-123&conversation_id={conversation_id}' --header 'Authorization: Bearer {api_key}'`} /> 
### Response Example
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
"limit": 20,
"has_more": false,
"data": [
    {
        "id": "a076a87f-31e5-48dc-b452-0061adbbc922",
        "conversation_id": "cd78daf6-f9e4-4463-9ff2-54257230a0ce",
        "inputs": {
            "name": "dify"
        },
        "query": "iphone 13 pro",
        "answer": "The iPhone 13 Pro, released on September 24, 2021, features a 6.1-inch display with a resolution of 1170 x 2532. It is equipped with a Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard) processor, 6 GB of RAM, and offers storage options of 128 GB, 256 GB, 512 GB, and 1 TB. The camera is 12 MP, the battery capacity is 3095 mAh, and it runs on iOS 15.",
        "message_files": [],
        "feedback": null,
        "retriever_resources": [
            {
                "position": 1,
                "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb",
                "dataset_name": "iPhone",
                "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00",
                "document_name": "iPhone List",
                "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a",
                "score": 0.98457545,
                "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"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\""
            }
        ],
        "created_at": 1705569239
    }
  ]
}
```
</CodeGroup>

### Response Example(智能助手)
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
"limit": 20,
"has_more": false,
"data": [
    {
        "id": "d35e006c-7c4d-458f-9142-be4930abdf94",
        "conversation_id": "957c068b-f258-4f89-ba10-6e8a0361c457",
        "inputs": {},
        "query": "draw a cat",
        "answer": "I have generated an image of a cat for you. Please check your messages to view the image.",
        "message_files": [
            {
                "id": "976990d2-5294-47e6-8f14-7356ba9d2d76",
                "type": "image",
                "url": "http://127.0.0.1:5001/files/tools/976990d2-5294-47e6-8f14-7356ba9d2d76.png?timestamp=1705988524&nonce=55df3f9f7311a9acd91bf074cd524092&sign=z43nMSO1L2HBvoqADLkRxr7Biz0fkjeDstnJiCK1zh8=",
                "belongs_to": "assistant"
            }
        ],
        "feedback": null,
        "retriever_resources": [],
        "created_at": 1705988187
    }
    ]
}
```
</CodeGroup>
</Col> </Row>

<Heading url='/conversations' method='GET' title='获取会话列表' name='#conversations' /> <Row>

<Col> 获取当前用户的会话列表，默认返回最近的 20 条。 
### Query

<Properties>
  <Property name='user' type='string' key='user'>
    用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
  </Property>
  <Property name='last_id' type='string' key='last_id'>
    （选填）当前页最后面一条记录的 ID，默认 null
  </Property>
  <Property name='limit' type='int' key='limit'>
    （选填）一次请求返回多少条记录，默认 20 条，最大 100 条，最小 1 条。
  </Property>
  <Property name='sort_by' type='string' key='sort_by'>
    （选填）排序字段，默认 -updated_at(按更新时间倒序排列)
    - 可选值：created_at, -created_at, updated_at, -updated_at
    - 字段前面的符号代表顺序或倒序，-代表倒序
  </Property>
</Properties>

### Response
- `data` (array[object]) 会话列表
  - `id`  (string) 会话 ID
  - `name`  (string) 会话名称，默认由大语言模型生成。
  - `inputs` (object) 用户输入参数。
  - `status` (string) 会话状态
  - `introduction` (string) 开场白
  - `created_at` (timestamp) 创建时间
  - `updated_at` (timestamp) 更新时间
- `has_more` (bool)
- `limit` (int) 返回条数，若传入超过系统限制，返回系统限制数量
</Col> <Col sticky> 
<CodeGroup
  title="Request"
  tag="GET"
  label="/conversations"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/conversations?user=abc-123&last_id=&limit=20' \\

--header 'Authorization: Bearer {api_key}'`} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "limit": 20,
  "has_more": false,
  "data": [
    {
      "id": "10799fb8-64f7-4296-bbf7-b42bfbe0ae54",
      "name": "New chat",
      "inputs": {
          "book": "book",
          "myName": "Lucy"
      },
      "status": "normal",
      "created_at": 1679667915,
      "updated_at": 1679667915
    },
    {
      "id": "hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}
```
</CodeGroup>
</Col> </Row>

<Heading url='/conversations/:conversation_id' method='DELETE' title='删除会话' name='#delete' /> <Row>

<Col> 删除会话。 
### Path
- `conversation_id` (string) 会话 ID

### Request Body

<Properties>
  <Property name='user' type='string' key='user'>
    用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
  </Property>
</Properties>

### Response
- `result` (string) 固定返回 success
</Col> <Col sticky> 
<CodeGroup
  title="Request"
  tag="DELETE"
  label="/conversations/:conversation_id"
  targetCode={`curl -X DELETE '${props.appDetail.api_base_url}/conversations/{conversation_id}' \\

--header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data '{ "user": "abc-123" }'`} />

<CodeGroup title="Response">
```text {{ title: 'Response' }}
204 No Content
```
</CodeGroup>
</Col> </Row>

<Heading url='/conversations/:conversation_id/name' method='POST' title='会话重命名' name='#rename' /> <Row>

<Col> 对会话进行重命名，会话名称用于显示在支持多会话的客户端上。 
### Path
- `conversation_id` (string) 会话 ID

### Request Body

<Properties>
  <Property name='name' type='string' key='name'>
    （选填）名称，若 `auto_generate` 为 `true` 时，该参数可不传。
  </Property>
  <Property name='auto_generate' type='bool' key='auto_generate'>
    （选填）自动生成标题，默认 false。
  </Property>
  <Property name='user' type='string' key='user'>
    用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
  </Property>
</Properties>

### Response
- `id`  (string) 会话 ID
- `name`  (string) 会话名称
- `inputs` (object) 用户输入参数
- `status` (string) 会话状态
- `introduction` (string) 开场白
- `created_at` (timestamp) 创建时间
- `updated_at` (timestamp) 更新时间
</Col> <Col sticky> 
<CodeGroup
  title="Request"
  tag="POST"
  label="/conversations/:conversation_id/name"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/conversations/{conversation_id}/name' \\

--header 'Content-Type: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data-raw '{ "name": "", "auto_generate": true, "user": "abc-123" }'`} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "id": "34d511d5-56de-4f16-a997-57b379508443",
  "name": "hello",
  "inputs": {},
  "status": "normal",
  "introduction": "",
  "created_at": 1732731141,
  "updated_at": 1732734510
}
```
</CodeGroup>
</Col> </Row>

<Heading url='/conversations/:conversation_id/variables' method='GET' title='获取对话变量' name='#conversation-variables' /> <Row>

<Col> 从特定对话中检索变量。此端点对于提取对话过程中捕获的结构化数据非常有用。 
### 路径参数

<Properties>
  <Property name='conversation_id' type='string' key='conversation_id'>
    要从中检索变量的对话ID。
  </Property>
</Properties>

### 查询参数

<Properties>
  <Property name='user' type='string' key='user'>
    用户标识符，由开发人员定义的规则，在应用程序内必须唯一。
  </Property>
  <Property name='last_id' type='string' key='last_id'>
    （选填）当前页最后面一条记录的 ID，默认 null
  </Property>
  <Property name='limit' type='int' key='limit'>
    （选填）一次请求返回多少条记录，默认 20 条，最大 100 条，最小 1 条。
  </Property>
</Properties>

### 响应

- `limit` (int) 每页项目数
- `has_more` (bool) 是否有更多项目
- `data` (array[object]) 变量列表
  - `id` (string) 变量 ID
  - `name` (string) 变量名称
  - `value_type` (string) 变量类型（字符串、数字、布尔等）
  - `value` (string) 变量值
  - `description` (string) 变量描述
  - `created_at` (int) 创建时间戳
  - `updated_at` (int) 最后更新时间戳

### 错误
- 404, `conversation_not_exists`, 对话不存在
</Col> <Col sticky> 
<CodeGroup
  title="Request"
  tag="GET"
  label="/conversations/:conversation_id/variables"
  debug="true"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/conversations/{conversation_id}/variables?user=abc-123' \\

--header 'Authorization: Bearer {api_key}'`} />

<CodeGroup
  title="带变量名过滤的请求"
  language="bash"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/conversations/{conversation_id}/variables?user=abc-123&variable_name=customer_name' \\

--header 'Authorization: Bearer {api_key}'`} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "limit": 100,
  "has_more": false,
  "data": [
    {
      "id": "variable-uuid-1",
      "name": "customer_name",
      "value_type": "string",
      "value": "John Doe",
      "description": "客户名称（从对话中提取）",
      "created_at": 1650000000000,
      "updated_at": 1650000000000
    },
    {
      "id": "variable-uuid-2",
      "name": "order_details",
      "value_type": "json",
      "value": "{\"product\":\"Widget\",\"quantity\":5,\"price\":19.99}",
      "description": "客户的订单详情",
      "created_at": 1650000000000,
      "updated_at": 1650000000000
    }
  ]
}
```
</CodeGroup>
</Col> </Row>

<Heading url='/conversations/:conversation_id/variables/:variable_id' method='PUT' title='更新对话变量' name='#update-conversation-variable' /> <Row>

<Col> 更新特定对话变量的值。此端点允许您修改在对话过程中捕获的变量值，同时保留其名称、类型和描述。 
### 路径参数

<Properties>
  <Property name='conversation_id' type='string' key='conversation_id'>
    包含要更新变量的对话ID。
  </Property>
  <Property name='variable_id' type='string' key='variable_id'>
    要更新的变量ID。
  </Property>
</Properties>

### 请求体

<Properties>
  <Property name='value' type='any' key='value'>
    变量的新值。必须匹配变量的预期类型（字符串、数字、对象等）。
  </Property>
  <Property name='user' type='string' key='user'>
    用户标识符，由开发人员定义的规则，在应用程序内必须唯一。
  </Property>
</Properties>

### 响应

返回包含以下内容的更新变量对象：
- `id` (string) 变量ID
- `name` (string) 变量名称
- `value_type` (string) 变量类型（字符串、数字、对象等）
- `value` (any) 更新后的变量值
- `description` (string) 变量描述
- `created_at` (int) 创建时间戳
- `updated_at` (int) 最后更新时间戳

### 错误
- 400, `Type mismatch: variable expects {expected_type}, but got {actual_type} type`, 值类型与变量的预期类型不匹配
- 404, `conversation_not_exists`, 对话不存在
- 404, `conversation_variable_not_exists`, 变量不存在
</Col> <Col sticky> 
<CodeGroup
  title="Request"
  tag="PUT"
  label="/conversations/:conversation_id/variables/:variable_id"
  targetCode={`curl -X PUT '${props.appDetail.api_base_url}/conversations/{conversation_id}/variables/{variable_id}' \\

--header 'Content-Type: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data-raw '{ "value": "Updated Value", "user": "abc-123" }'`} />

<CodeGroup
  title="使用不同值类型更新"
  targetCode={[
    {
      title: '字符串值',
      code: `curl -X PUT '${props.appDetail.api_base_url}/conversations/{conversation_id}/variables/{variable_id}' \\

--header 'Content-Type: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data-raw '{ "value": "新的字符串值", "user": "abc-123" }', }, { title: '数字值', code: curl -X PUT '${props.appDetail.api_base_url}/conversations/{conversation_id}/variables/{variable_id}' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data-raw '{ "value": 42, "user": "abc-123" }', }, { title: '对象值', code: curl -X PUT '${props.appDetail.api_base_url}/conversations/{conversation_id}/variables/{variable_id}' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data-raw '{ "value": {"product": "Widget", "quantity": 10, "price": 29.99}, "user": "abc-123" }'`, }, ]} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "id": "variable-uuid-1",
  "name": "customer_name",
  "value_type": "string",
  "value": "Updated Value",
  "description": "客户名称（从对话中提取）",
  "created_at": 1650000000000,
  "updated_at": 1650000001000
}
```
</CodeGroup>
</Col> </Row>

<Heading url='/audio-to-text' method='POST' title='语音转文字' name='#audio-to-text' /> <Row>

<Col> ### Request Body 该接口需使用 `multipart/form-data` 进行请求。 <Properties> <Property name='file' type='file' key='file'> 语音文件。 支持格式：`['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']` 文件大小限制：15MB </Property> <Property name='user' type='string' key='user'> 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。 </Property> </Properties> 
### Response
- `text` (string) 输出文字
</Col> <Col sticky> 
<CodeGroup
  title="Request"
  tag="POST"
  label="/audio-to-text"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/audio-to-text' \\

--header 'Authorization: Bearer {api_key}' \ --form 'file=@localfile;type=audio/[mp3|mp4|mpeg|mpga|m4a|wav|webm]'`} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "text": "hello"
}
```
</CodeGroup>
</Col> </Row>

<Heading url='/text-to-audio' method='POST' title='文字转语音' name='#text-to-audio' /> <Row>

<Col> 文字转语音。 
### Request Body

<Properties>
  <Property name='message_id' type='str' key='message_id'>
    Dify 生成的文本消息，那么直接传递生成的message-id 即可，后台会通过 message_id 查找相应的内容直接合成语音信息。如果同时传 message_id 和 text，优先使用 message_id。
  </Property>
  <Property name='text' type='str' key='text'>
    语音生成内容。如果没有传 message-id的话，则会使用这个字段的内容
  </Property>
  <Property name='user' type='string' key='user'>
    用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
  </Property>
</Properties>
</Col> <Col sticky> 
<CodeGroup
  title="Request"
  tag="POST"
  label="/text-to-audio"
  targetCode={`curl -o text-to-audio.mp3 -X POST '${props.appDetail.api_base_url}/text-to-audio' \\

--header 'Authorization: Bearer {api_key}' \ --header 'Content-Type: application/json' \ --data-raw '{ "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "text": "Hello Dify", "user": "abc-123", }'`} />

<CodeGroup title="headers">
```json {{ title: 'headers' }}
{
  "Content-Type": "audio/wav"
}
```
</CodeGroup>
</Col> </Row> ---

<Heading url='/info' method='GET' title='获取应用基本信息' name='#info' /> <Row>

<Col> 用于获取应用的基本信息 ### Response - `name` (string) 应用名称 - `description` (string) 应用描述 - `tags` (array[string]) 应用标签 </Col> <Col> <CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\ -H 'Authorization: Bearer {api_key}'`} /> <CodeGroup title="Response"> ```json {{ title: 'Response' }} { "name": "My App", "description": "This is my app.", "tags": [ "tag1", "tag2" ], "mode": "advanced-chat", "author_name": "Dify" } ``` </CodeGroup> </Col> </Row>

<Heading url='/parameters' method='GET' title='获取应用参数' name='#parameters' /> <Row>

<Col> 用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。 
### Response
- `opening_statement` (string) 开场白
- `suggested_questions` (array[string]) 开场推荐问题列表
- `suggested_questions_after_answer` (object) 启用回答后给出推荐问题。
  - `enabled` (bool) 是否开启
- `speech_to_text` (object) 语音转文本
  - `enabled` (bool) 是否开启
- `text_to_speech` (object) 文本转语音
  - `enabled` (bool) 是否开启
  - `voice` (string) 语音类型
  - `language` (string) 语言
  - `autoPlay` (string) 自动播放
    - `enabled`  开启
    - `disabled` 关闭
- `retriever_resource` (object) 引用和归属
  - `enabled` (bool) 是否开启
- `annotation_reply` (object) 标记回复
  - `enabled` (bool) 是否开启
- `user_input_form` (array[object]) 用户输入表单配置
  - `text-input` (object) 文本输入控件
    - `label` (string) 控件展示标签名
    - `variable` (string) 控件 ID
    - `required` (bool) 是否必填
    - `default` (string) 默认值
  - `paragraph` (object) 段落文本输入控件
    - `label` (string) 控件展示标签名
    - `variable` (string) 控件 ID
    - `required` (bool) 是否必填
    - `default` (string) 默认值
  - `select` (object) 下拉控件
    - `label` (string) 控件展示标签名
    - `variable` (string) 控件 ID
    - `required` (bool) 是否必填
    - `default` (string) 默认值
    - `options` (array[string]) 选项值
- `file_upload` (object) 文件上传配置
  - `document` (object) 文档设置
    当前仅支持文档类型：`txt`, `md`, `markdown`, `pdf`, `html`, `xlsx`, `xls`, `docx`, `csv`, `eml`, `msg`, `pptx`, `ppt`, `xml`, `epub`。
    - `enabled` (bool) 是否启用
    - `number_limits` (int) 文档数量限制，默认为 3
    - `transfer_methods` (array[string]) 传输方式列表：`remote_url`, `local_file`，必须选择一个。
  - `image` (object) 图片设置
    当前仅支持图片类型：`png`, `jpg`, `jpeg`, `webp`, `gif`。
    - `enabled` (bool) 是否启用
    - `number_limits` (int) 图片数量限制，默认为 3
    - `transfer_methods` (array[string]) 传输方式列表：`remote_url`, `local_file`，必须选择一个。
  - `audio` (object) 音频设置
    当前仅支持音频类型：`mp3`, `m4a`, `wav`, `webm`, `amr`。
    - `enabled` (bool) 是否启用
    - `number_limits` (int) 音频数量限制，默认为 3
    - `transfer_methods` (array[string]) 传输方式列表：`remote_url`, `local_file`，必须选择一个。
  - `video` (object) 视频设置
    当前仅支持视频类型：`mp4`, `mov`, `mpeg`, `mpga`。
    - `enabled` (bool) 是否启用
    - `number_limits` (int) 视频数量限制，默认为 3
    - `transfer_methods` (array[string]) 传输方式列表：`remote_url`, `local_file`，必须选择一个。
  - `custom` (object) 自定义设置
    - `enabled` (bool) 是否启用
    - `number_limits` (int) 自定义数量限制，默认为 3
    - `transfer_methods` (array[string]) 传输方式列表：`remote_url`, `local_file`，必须选择一个。
- `system_parameters` (object) 系统参数
  - `file_size_limit` (int) Document upload size limit (MB)
  - `image_file_size_limit` (int) Image file upload size limit (MB)
  - `audio_file_size_limit` (int) Audio file upload size limit (MB)
  - `video_file_size_limit` (int) Video file upload size limit (MB)
</Col> <Col sticky> 
<CodeGroup
  title="Request"
  tag="GET"
  label="/parameters"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/parameters'`}
/>

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "introduction": "nice to meet you",
  "user_input_form": [
    {
      "text-input": {
        "label": "a",
        "variable": "a",
        "required": true,
        "max_length": 48,
        "default": ""
      }
    },
    {
      // ...
    }
  ],
  "file_upload": {
    "image": {
      "enabled": true,
      "number_limits": 3,
      "transfer_methods": [
        "remote_url",
        "local_file"
      ]
    }
  },
  "system_parameters": {
      "file_size_limit": 15,
      "image_file_size_limit": 10,
      "audio_file_size_limit": 50,
      "video_file_size_limit": 100
  }
}
```
</CodeGroup>
</Col> </Row>

<Heading url='/meta' method='GET' title='获取应用Meta信息' name='#meta' /> <Row>

<Col> 用于获取工具 icon ### Response - `tool_icons`(object[string]) 工具图标 - `工具名称` (string) - `icon` (object|string) - (object) 图标 - `background` (string) hex 格式的背景色 - `content`(string) emoji - (string) 图标 URL </Col> <Col> <CodeGroup title="Request" tag="GET" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta' \\ -H 'Authorization: Bearer {api_key}'`} /> 
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "tool_icons": {
      "dalle2": "https://cloud.dify.ai/console/api/workspaces/current/tool-provider/builtin/dalle/icon",
      "api_tool": {
          "background": "#252525",
          "content": "\ud83d\ude01"
      }
  }
}
```
</CodeGroup>
</Col> </Row> ---

<Heading url='/site' method='GET' title='获取应用 WebApp 设置' name='#site' /> <Row>

<Col> 用于获取应用的 WebApp 设置 ### Response - `title` (string) WebApp 名称 - `chat_color_theme` (string) 聊天颜色主题，hex 格式 - `chat_color_theme_inverted` (bool) 聊天颜色主题是否反转 - `icon_type` (string) 图标类型，`emoji`-表情，`image`-图片 - `icon` (string) 图标，如果是 `emoji` 类型，则是 emoji 表情符号，如果是 `image` 类型，则是图片 URL - `icon_background` (string) hex 格式的背景色 - `icon_url` (string) 图标 URL - `description` (string) 描述 - `copyright` (string) 版权信息 - `privacy_policy` (string) 隐私政策链接 - `custom_disclaimer` (string) 自定义免责声明 - `default_language` (string) 默认语言 - `show_workflow_steps` (bool) 是否显示工作流详情 - `use_icon_as_answer_icon` (bool) 是否使用 WebApp 图标替换聊天中的 🤖 </Col> <Col> <CodeGroup title="Request" tag="GET" label="/site" targetCode={`curl -X GET '${props.appDetail.api_base_url}/site' \\ -H 'Authorization: Bearer {api_key}'`} /> 
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "title": "My App",
  "chat_color_theme": "#ff4a4a",
  "chat_color_theme_inverted": false,
  "icon_type": "emoji",
  "icon": "😄",
  "icon_background": "#FFEAD5",
  "icon_url": null,
  "description": "This is my app.",
  "copyright": "all rights reserved",
  "privacy_policy": "",
  "custom_disclaimer": "All generated by AI",
  "default_language": "en-US",
  "show_workflow_steps": false,
  "use_icon_as_answer_icon": false,
}
```
</CodeGroup>
</Col> </Row> ___

<Heading url='/apps/annotations' method='GET' title='获取标注列表' name='#annotation_list' /> <Row>

<Col> ### Query <Properties> <Property name='page' type='string' key='page'> 页码 </Property> <Property name='limit' type='string' key='limit'> 每页数量 </Property> </Properties> </Col> <Col sticky> <CodeGroup title="Request" tag="GET" label="/apps/annotations" targetCode={`curl --location --request GET '${props.appDetail.api_base_url}/apps/annotations?page=1&limit=20' \\ --header 'Authorization: Bearer {api_key}'`} /> 
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "data": [
    {
      "id": "69d48372-ad81-4c75-9c46-2ce197b4d402",
      "question": "What is your name?",
      "answer": "I am Dify.",
      "hit_count": 0,
      "created_at": 1735625869
    }
  ],
  "has_more": false,
  "limit": 20,
  "total": 1,
  "page": 1
}
```
</CodeGroup>
</Col> </Row> ---

<Heading url='/apps/annotations' method='POST' title='创建标注' name='#create_annotation' /> <Row>

<Col> ### Query <Properties> <Property name='question' type='string' key='question'> 问题 </Property> <Property name='answer' type='string' key='answer'> 答案内容 </Property> </Properties> </Col> <Col sticky> <CodeGroup title="Request" tag="POST" label="/apps/annotations" targetCode={`curl --location --request POST '${props.appDetail.api_base_url}/apps/annotations' \\ --header 'Authorization: Bearer {api_key}' \\ --header 'Content-Type: application/json' \\ --data-raw '{ "question": "What is your name?", "answer": "I am Dify." }'`} /> 
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "id": "69d48372-ad81-4c75-9c46-2ce197b4d402",
  "question": "What is your name?",
  "answer": "I am Dify.",
  "hit_count": 0,
  "created_at": 1735625869
}
```
</CodeGroup>
</Col> </Row> ---

<Heading url='/apps/annotations/{annotation_id}' method='PUT' title='更新标注' name='#update_annotation' /> <Row>

<Col> ### Query <Properties> <Property name='annotation_id' type='string' key='annotation_id'> 标注 ID </Property> <Property name='question' type='string' key='question'> 问题 </Property> <Property name='answer' type='string' key='answer'> 答案内容 </Property> </Properties> </Col> <Col sticky> <CodeGroup title="Request" tag="PUT" label="/apps/annotations/{annotation_id}" targetCode={`curl --location --request PUT '${props.appDetail.api_base_url}/apps/annotations/{annotation_id}' \\ --header 'Authorization: Bearer {api_key}' \\ --header 'Content-Type: application/json' \\ --data-raw '{ "question": "What is your name?", "answer": "I am Dify." }'`} /> 
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "id": "69d48372-ad81-4c75-9c46-2ce197b4d402",
  "question": "What is your name?",
  "answer": "I am Dify.",
  "hit_count": 0,
  "created_at": 1735625869
}
```
</CodeGroup>
</Col> </Row> ---

<Heading url='/apps/annotations/{annotation_id}' method='DELETE' title='删除标注' name='#delete_annotation' /> <Row>

<Col> ### Query <Properties> <Property name='annotation_id' type='string' key='annotation_id'> 标注 ID </Property> </Properties> </Col> <Col sticky> <CodeGroup title="Request" tag="DELETE" label="/apps/annotations/{annotation_id}" targetCode={`curl --location --request DELETE '${props.appDetail.api_base_url}/apps/annotations/{annotation_id}' \\ --header 'Authorization: Bearer {api_key}' \\ --header 'Content-Type: application/json'`} /> 
<CodeGroup title="Response">
```text {{ title: 'Response' }}
204 No Content
```
</CodeGroup>
</Col> </Row> ---

<Heading url='/apps/annotation-reply/{action}' method='POST' title='标注回复初始设置' name='#initial_annotation_reply_settings' /> <Row>

<Col> ### Query <Properties> <Property name='action' type='string' key='action'> 动作，只能是 'enable' 或 'disable' </Property> <Property name='embedding_provider_name' type='string' key='embedding_provider_name'> 指定的嵌入模型提供商，必须先在系统内设定好接入的模型，对应的是 provider 字段 </Property> <Property name='embedding_model_name' type='string' key='embedding_model_name'> 指定的嵌入模型，对应的是 model 字段 </Property> <Property name='score_threshold' type='number' key='score_threshold'> 相似度阈值，当相似度大于该阈值时，系统会自动回复，否则不回复 </Property> </Properties> </Col> <Col sticky> 嵌入模型的提供商和模型名称可以通过以下接口获取：v1/workspaces/current/models/model-types/text-embedding，具体见：通过 API 维护知识库。使用的 Authorization 是 Dataset 的 API Token。 <CodeGroup title="Request" tag="POST" label="/apps/annotation-reply/{action}" targetCode={`curl --location --request POST '${props.appDetail.api_base_url}/apps/annotation-reply/{action}' \\ --header 'Authorization: Bearer {api_key}' \\ --header 'Content-Type: application/json' \\ --data-raw '{ "score_threshold": 0.9, "embedding_provider_name": "zhipu", "embedding_model_name": "embedding_3" }'`} /> 
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "job_id": "b15c8f68-1cf4-4877-bf21-ed7cf2011802",
  "job_status": "waiting"
}
```
</CodeGroup>
该接口是异步执行，所以会返回一个job_id，通过查询job状态接口可以获取到最终的执行结果。
</Col> </Row> ---

<Heading url='/apps/annotation-reply/{action}/status/{job_id}' method='GET' title='查询标注回复初始设置任务状态' name='#initial_annotation_reply_settings_task_status' /> <Row>

<Col> ### Query <Properties> <Property name='action' type='string' key='action'> 动作，只能是 'enable' 或 'disable'，并且必须和标注回复初始设置接口的动作一致 </Property> <Property name='job_id' type='string' key='job_id'> 任务 ID，从标注回复初始设置接口返回的 job_id </Property> </Properties> </Col> <Col sticky> <CodeGroup title="Request" tag="GET" label="/apps/annotations" targetCode={`curl --location --request GET '${props.appDetail.api_base_url}/apps/annotation-reply/{action}/status/{job_id}' \\ --header 'Authorization: Bearer {api_key}'`} /> 
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "job_id": "b15c8f68-1cf4-4877-bf21-ed7cf2011802",
  "job_status": "waiting",
  "error_msg": ""
}
```
</CodeGroup>
</Col> </Row>