### Request Body

<Properties>
  <Property name='query' type='string' key='query'>
    用户输入/提问内容。
  </Property>
  <Property name='inputs' type='object' key='inputs'>
    允许传入 App 定义的各变量值。
    inputs 参数包含了多组键值对（Key/Value pairs），每组的键对应一个特定变量，每组的值则是该变量的具体值。
    默认 `{}`
  </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>
    注：Agent模式下不允许blocking。
  </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，用于指定特定版本，如果不提供则使用默认的已发布版本。

  获取方式：在版本历史界面，点击每个版本条目右侧的复制图标即可复制完整的工作流 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: agent_message` Agent模式下返回文本块事件，即：在Agent模式下，文章的文本以分块的方式输出（仅Agent模式下使用）
  - `task_id` (string) 任务 ID，用于请求跟踪和下方的停止响应接口
  - `message_id` (string) 消息唯一 ID
  - `conversation_id` (string) 会话 ID
  - `answer` (string) LLM 返回文本块内容
  - `created_at` (int) 创建时间戳，如：1705395332
- `event: agent_thought` Agent模式下有关Agent思考步骤的相关内容，涉及到工具调用（仅Agent模式下使用）
  - `id` (string) agent_thought ID，每一轮Agent迭代都会有一个唯一的id
  - `task_id` (string) 任务ID，用于请求跟踪下方的停止响应接口
  - `message_id` (string) 消息唯一ID
  - `position` (int) agent_thought在消息中的位置，如第一轮迭代position为1
  - `thought` (string) agent的思考内容
  - `observation` (string) 工具调用的返回结果
  - `tool` (string) 使用的工具列表，以 ; 分割多个工具
  - `tool_input` (string) 工具的输入，JSON格式的字符串(object)。如：`{"dalle3": {"prompt": "a cute cat"}}`
  - `created_at` (int) 创建时间戳，如：1705395332
  - `message_files` (array[string])  当前 `agent_thought` 关联的文件ID
    - `file_id` (string) 文件ID
  - `conversation_id` (string) 会话ID
- `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: 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>

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

### 流式模式（智能助手）
<CodeGroup title="Response">
```streaming {{ title: 'Response' }}
  data: {"event": "agent_thought", "id": "8dcf3648-fbad-407a-85dd-73a6f43aeb9f", "task_id": "9cf1ddd7-f94b-459b-b942-b77b26c59e9b", "message_id": "1fb10045-55fd-4040-99e6-d048d07cbad3", "position": 1, "thought": "", "observation": "", "tool": "", "tool_input": "", "created_at": 1705639511, "message_files": [], "conversation_id": "c216c595-2d89-438c-b33c-aae5ddddd142"}
  data: {"event": "agent_thought", "id": "8dcf3648-fbad-407a-85dd-73a6f43aeb9f", "task_id": "9cf1ddd7-f94b-459b-b942-b77b26c59e9b", "message_id": "1fb10045-55fd-4040-99e6-d048d07cbad3", "position": 1, "thought": "", "observation": "", "tool": "dalle3", "tool_input": "{\"dalle3\": {\"prompt\": \"cute Japanese anime girl with white hair, blue eyes, bunny girl suit\"}}", "created_at": 1705639511, "message_files": [], "conversation_id": "c216c595-2d89-438c-b33c-aae5ddddd142"}
  data: {"event": "message_file", "id": "d75b7a5c-ce5e-442e-ab1b-d6a5e5b557b0", "type": "image", "belongs_to": "assistant", "url": "http://127.0.0.1:5001/files/tools/d75b7a5c-ce5e-442e-ab1b-d6a5e5b557b0.png?timestamp=1705639526&nonce=70423256c60da73a9c96d1385ff78487&sign=7B5fKV9890YJuqchQvrABvW4AIupDvDvxGdu1EOJT94=", "conversation_id": "c216c595-2d89-438c-b33c-aae5ddddd142"}
  data: {"event": "agent_thought", "id": "8dcf3648-fbad-407a-85dd-73a6f43aeb9f", "task_id": "9cf1ddd7-f94b-459b-b942-b77b26c59e9b", "message_id": "1fb10045-55fd-4040-99e6-d048d07cbad3", "position": 1, "thought": "", "observation": "image has been created and sent to user already, you should tell user to check it now.", "tool": "dalle3", "tool_input": "{\"dalle3\": {\"prompt\": \"cute Japanese anime girl with white hair, blue eyes, bunny girl suit\"}}", "created_at": 1705639511, "message_files": ["d75b7a5c-ce5e-442e-ab1b-d6a5e5b557b0"], "conversation_id": "c216c595-2d89-438c-b33c-aae5ddddd142"}
  data: {"event": "agent_thought", "id": "67a99dc1-4f82-42d3-b354-18d4594840c8", "task_id": "9cf1ddd7-f94b-459b-b942-b77b26c59e9b", "message_id": "1fb10045-55fd-4040-99e6-d048d07cbad3", "position": 2, "thought": "", "observation": "", "tool": "", "tool_input": "", "created_at": 1705639511, "message_files": [], "conversation_id": "c216c595-2d89-438c-b33c-aae5ddddd142"}
  data: {"event": "agent_message", "id": "1fb10045-55fd-4040-99e6-d048d07cbad3", "task_id": "9cf1ddd7-f94b-459b-b942-b77b26c59e9b", "message_id": "1fb10045-55fd-4040-99e6-d048d07cbad3", "answer": "I have created an image of a cute Japanese", "created_at": 1705639511, "conversation_id": "c216c595-2d89-438c-b33c-aae5ddddd142"}
  data: {"event": "agent_message", "id": "1fb10045-55fd-4040-99e6-d048d07cbad3", "task_id": "9cf1ddd7-f94b-459b-b942-b77b26c59e9b", "message_id": "1fb10045-55fd-4040-99e6-d048d07cbad3", "answer": " anime girl with white hair and blue", "created_at": 1705639511, "conversation_id": "c216c595-2d89-438c-b33c-aae5ddddd142"}
  data: {"event": "agent_message", "id": "1fb10045-55fd-4040-99e6-d048d07cbad3", "task_id": "9cf1ddd7-f94b-459b-b942-b77b26c59e9b", "message_id": "1fb10045-55fd-4040-99e6-d048d07cbad3", "answer": " eyes wearing a bunny girl" ,"created_at": 1705639511, "conversation_id": "c216c595-2d89-438c-b33c-aae5ddddd142"}
  data: {"event": "agent_message", "id": "1fb10045-55fd-4040-99e6-d048d07cbad3", "task_id": "9cf1ddd7-f94b-459b-b942-b77b26c59e9b", "message_id": "1fb10045-55fd-4040-99e6-d048d07cbad3", "answer": " suit .", "created_at": 1705639511, "conversation_id": "c216c595-2d89-438c-b33c-aae5ddddd142"}
  data: {"event": "agent_thought", "id": "67a99dc1-4f82-42d3-b354-18d4594840c8", "task_id": "9cf1ddd7-f94b-459b-b942-b77b26c59e9b", "message_id": "1fb10045-55fd-4040-99e6-d048d07cbad3", "position": 2, "thought": "I have created an image of a cute Japanese anime girl with white hair and blue eyes wearing a bunny girl suit.", "observation": "", "tool": "", "tool_input": "", "created_at": 1705639511, "message_files": [], "conversation_id": "c216c595-2d89-438c-b33c-aae5ddddd142"}
  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>

### Request Body
该接口需使用  `multipart/form-data` 进行请求。
<Properties>
  <Property name='file' type='file' key='file'>
    要上传的文件。
  </Property>
  <Property name='user' type='string' key='user'>
      用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。服务 API 不会共享 WebApp 创建的对话。
  </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 大小限制

<CodeGroup
  title="Request"
  tag="POST"
  label="/files/upload"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/files/upload' \\

<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>

当其他 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，内部服务器错误

<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>

<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, 服务内部错误

```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/files/72fa9618-8f89-4a37-9b33-7e1178a24a67/preview' \
--header 'Authorization: Bearer {api_key}'
```

</CodeGroup>

### 作为附件下载
<CodeGroup title="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' \\

### 响应标头示例
<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>

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

### 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'>
      用户标识，由开发者定义规则，需保证用户标识在应用内唯一。服务 API 不会共享 WebApp 创建的对话。
  </Property>
  <Property name='content' type='string' key='content'>
      消息反馈的具体信息。
  </Property>
</Properties>

### Response
- `result` (string) 固定返回 success

<CodeGroup
  title="Request"
  tag="POST"
  label="/messages/:message_id/feedbacks"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/messages/:message_id/feedbacks \\

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

### 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的点赞、反馈列表。

<CodeGroup
  title="Request"
  tag="GET"
  label="/app/feedbacks"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/app/feedbacks?page=1&limit=20'`}
/>

<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>

### 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>

<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 \\

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

### 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
    - `agent_thoughts` (array[object]) Agent思考内容（仅Agent模式下不为空）
      - `id` (string) agent_thought ID，每一轮Agent迭代都会有一个唯一的id
      - `message_id` (string) 消息唯一ID
      - `position` (int) agent_thought在消息中的位置，如第一轮迭代position为1
      - `thought` (string) agent的思考内容
      - `observation` (string) 工具调用的返回结果
      - `tool` (string) 使用的工具列表，以 ; 分割多个工具
      - `tool_input` (string) 工具的输入，JSON格式的字符串(object)。如：`{"dalle3": {"prompt": "a cute cat"}}`
      - `created_at` (int) 创建时间戳，如：1705395332
      - `message_files` (array[string])  当前agent_thought 关联的文件ID
        - `file_id` (string) 文件ID
      - `conversation_id` (string) 会话ID
  - `answer` (string)  回答消息内容
  - `created_at`  (timestamp) 创建时间
  - `feedback` (object) 反馈信息
    - `rating` (string) 点赞 like / 点踩 dislike
  - `retriever_resources` (array[RetrieverResource]) 引用和归属分段列表
- `has_more` (bool) 是否存在下一页
- `limit` (int) 返回条数，若传入超过系统限制，返回系统限制数量

### 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\""
            }
        ],
        "agent_thoughts": [],
        "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,
        "agent_thoughts": [
            {
                "id": "592c84cf-07ee-441c-9dcc-ffc66c033469",
                "chain_id": null,
                "message_id": "d35e006c-7c4d-458f-9142-be4930abdf94",
                "position": 1,
                "thought": "",
                "tool": "dalle2",
                "tool_input": "{\"dalle2\": {\"prompt\": \"cat\"}}",
                "created_at": 1705988186,
                "observation": "image has been created and sent to user already, you should tell user to check it now.",
                "files": [
                    "976990d2-5294-47e6-8f14-7356ba9d2d76"
                ]
            },
            {
                "id": "73ead60d-2370-4780-b5ed-532d2762b0e5",
                "chain_id": null,
                "message_id": "d35e006c-7c4d-458f-9142-be4930abdf94",
                "position": 2,
                "thought": "I have generated an image of a cat for you. Please check your messages to view the image.",
                "tool": "",
                "tool_input": "",
                "created_at": 1705988199,
                "observation": "",
                "files": []
            }
        ]
    }
    ]
}
```
</CodeGroup>

### 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) 返回条数，若传入超过系统限制，返回系统限制数量

<CodeGroup
  title="Request"
  tag="GET"
  label="/conversations"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/conversations?user=abc-123&last_id=&limit=20'\\

<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>

### Path
- `conversation_id` (string) 会话 ID

### Request Body

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

### Response
- `result` (string) 固定返回 success

<CodeGroup
  title="Request"
  tag="DELETE"
  label="/conversations/:conversation_id"
  targetCode={`curl -X DELETE '${props.appDetail.api_base_url}/conversations/:conversation_id' \\

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

### 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) 更新时间

<CodeGroup
  title="Request"
  tag="POST"
  label="/conversations/:conversation_id/name"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/conversations/:conversation_id/name' \\

<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>

### 路径参数

<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`, 对话不存在

<CodeGroup
  title="Request"
  tag="GET"
  label="/conversations/:conversation_id/variables"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/conversations/{conversation_id}/variables?user=abc-123' \\

<CodeGroup title="Request with variable name filter">
```bash {{ title: 'cURL' }}
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>

<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>

### 路径参数

<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`, 变量不存在

<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}' \\

<CodeGroup title="使用不同值类型更新">
```bash {{ title: '字符串值' }}
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"
}'
```

```bash {{ title: '数字值' }}
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"
}'
```

```bash {{ title: '对象值' }}
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>

<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>

### Response
- `text` (string) 输出文字

<CodeGroup
  title="Request"
  tag="POST"
  label="/audio-to-text"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/audio-to-text' \\

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

### 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>

<CodeGroup
  title="Request"
  tag="POST"
  label="/text-to-audio"
  targetCode={`curl --location --request POST '${props.appDetail.api_base_url}/text-to-audio' \\

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

### 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) 文档上传大小限制 (MB)
  - `image_file_size_limit` (int) 图片文件上传大小限制（MB）
  - `audio_file_size_limit` (int) 音频文件上传大小限制 (MB)
  - `video_file_size_limit` (int) 视频文件上传大小限制 (MB)

<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>

<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>

<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>