# 清空会话

> 清空当前应用、Skill 调试或外链身份下的全部历史会话记录（执行软删除），支持应用 API Key 省略 appId。

Source: https://doc.fastgpt.cn/openapi/reference/chat-history/clear-histories
Last Updated: 2026-11-18

## 端点概览

* **HTTP 方法**：`DELETE`
* **请求路径**：`/api/core/chat/history/clearHistories`
* **所属模块**：对话 / 会话管理
* **鉴权方式**：`Authorization: Bearer <apiKey>`—支持 **应用 API Key**（无需 `appId`）与 **个人密钥**（需传 `appId`）；另支持 `authProxy` 团队成员代理与 `outLinkAuthData` 外链分享（详见 [API 入门：完成首次请求](https://doc.fastgpt.cn/openapi/intro)）
* **在线调试**：[在云服务 Scalar 调试台打开](https://cloud.fastgpt.cn/apidoc/systemopenapi#tag/%E4%BC%9A%E8%AF%9D%E7%AE%A1%E7%90%86/DELETE/core/chat/history/clearHistories)（自部署实例请将域名替换为 `<instance>/apidoc/systemopenapi#tag/%E4%BC%9A%E8%AF%9D%E7%AE%A1%E7%90%86/DELETE/core/chat/history/clearHistories`）

## 接口说明与注意事项

清空所有会话（软删除）

## 请求参数

### Query 查询参数

**互斥参数分支（`anyOf` 选填其一）**

* **应用会话**

通过 appId 定位会话。接口同时支持 API Key 和登录态时，Authorization 优先于 token/Cookie。

| 字段           | 类型              | 必填 | 默认值 | 约束与说明                                                                                             |
| ------------ | --------------- | -- | --- | ------------------------------------------------------------------------------------------------- |
| `appId`      | `string`        | 是  | -   | 应用 ID，使用接口允许的请求头凭证鉴权。正则：`^[0-9a-fA-F]{24}$`                                                       |
| `sourceType` | `string` (enum) | 否  | -   | appId 对应的会话资源类型。缺省为 App 会话；辅助生成会话传对应 sourceType。可选值：`app` , `chatAgentHelper` , `workflowBuilder` |

**默认身份**: 不传 customUid 和 authProxy，沿用凭证对应的团队成员身份。适用于直接以当前鉴权成员调用应用。

**自定义使用者**: 通过 customUid 对接自己平台的使用者，不改变鉴权成员及权限。发起对话时作为使用者和工作流 userId；管理对话时按该值限制使用者范围。

| 字段          | 类型       | 必填 | 默认值 | 约束与说明                                                                                                                                |
| ----------- | -------- | -- | --- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `customUid` | `string` | 是  | -   | 仅普通应用的 API Key 调用支持。精确匹配对话的外部使用者 ID（outLinkUid），不匹配 tmbId；省略时保留原访问范围，传入时限制读取、修改及删除。最长 1024 字符，不接受空字符串或 null，不改变鉴权成员。最小长度：1；最大长度：1024 |

**代理团队成员**: 通过 authProxy 代表同团队成员执行，解析出有效 tmbId 后按该成员权限校验。仅开启代理权限的个人密钥可用，与 customUid 互斥。

| 字段          | 类型       | 必填 | 默认值 | 约束与说明                                                        |
| ----------- | -------- | -- | --- | ------------------------------------------------------------ |
| `authProxy` | `string` | 是  | -   | 代理身份的 JSON 字符串，例如 \{"tmbId":"团队成员 ID"} 或 \{"username":"用户名"} |

* **Skill 调试会话**

通过 skillId 定位调试会话，优先于 appId 并忽略其 sourceType，使用接口允许的请求头凭证鉴权。

| 字段        | 类型       | 必填 | 默认值 | 约束与说明                                                  |
| --------- | -------- | -- | --- | ------------------------------------------------------ |
| `skillId` | `string` | 是  | -   | Skill Edit 调试 ID，使用接口允许的请求头凭证鉴权。正则：`^[0-9a-fA-F]{24}$` |

* **外链会话**

通过 outLinkAuthData 解析真实应用，优先于 skillId 和 appId 并忽略其 sourceType。外链身份优先于请求头身份；token/Cookie 可以同时传入，受保护外链仍会校验登录态。外链校验失败时不会回退到普通资源鉴权。

| 字段                | 类型       | 必填 | 默认值 | 约束与说明                                                                                                   |
| ----------------- | -------- | -- | --- | ------------------------------------------------------------------------------------------------------- |
| `outLinkAuthData` | `string` | 是  | -   | 外链鉴权数据的 JSON 字符串，包含 shareId 和 outLinkUid。优先于 skillId 和 appId，忽略低优先级字段；允许同时携带 token/Cookie，受保护外链仍需校验登录态。 |

* **应用 API Key（无需 appId）**

Authorization 使用绑定应用的 APP API Key 时无需传 appId 或 sourceType，服务端从 Key 绑定取得应用，sourceType 固定为 app。个人密钥和登录态不能使用此省略方式；显式传入 appId 时仍以 Key 绑定为准。

**默认身份**: 不传 customUid 和 authProxy，沿用凭证对应的团队成员身份。适用于直接以当前鉴权成员调用应用。

**自定义使用者**: 通过 customUid 对接自己平台的使用者，不改变鉴权成员及权限。发起对话时作为使用者和工作流 userId；管理对话时按该值限制使用者范围。

| 字段          | 类型       | 必填 | 默认值 | 约束与说明                                                                                                                                |
| ----------- | -------- | -- | --- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `customUid` | `string` | 是  | -   | 仅普通应用的 API Key 调用支持。精确匹配对话的外部使用者 ID（outLinkUid），不匹配 tmbId；省略时保留原访问范围，传入时限制读取、修改及删除。最长 1024 字符，不接受空字符串或 null，不改变鉴权成员。最小长度：1；最大长度：1024 |

## 请求示例

调用前请将 `YOUR_API_KEY` 与示例 ID 替换为真实值；私有化部署实例请将基础域名替换为 `<instance>/api`。

### cURL 请求示例

```bash
curl --fail-with-body -X DELETE "https://cloud.fastgpt.cn/api/core/chat/history/clearHistories?appId=68ad85a7463006c963799a05" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

## 响应结构与示例

除兼容 OpenAI 协议的对话补全或二进制下载接口外，成功响应统一包裹在 `{ "code": 200, "statusText": "", "message": "", "data": ... }` 标准结构中；下方 `200` 字段表对应 `data` 载荷结构（若契约未声明具体载荷结构，请以上方状态描述及实际响应为准）。

### HTTP 200

成功清空会话

返回 FastGPT 标准成功响应结构（`{ "code": 200, "statusText": "", "message": "", "data": ... }`）。当前 OpenAPI 契约暂未声明 `data` 的具体字段结构，请结合上方状态描述或实际返回结果处理。
