# 删除 UI 协议会话记录

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

维护当前用户会话记录。


```http
DELETE https://api.moi.matrixorigin.cn/v5/sessions/{session_id}
```

## 调用前准备

`BASE_URL` 使用产品 API 前缀 `https://api.moi.matrixorigin.cn/v5`；专有部署填写对应的产品 API 地址。

[配置同环境的身份、工作区和数值记录 ID](objects.md#prepare)。该入口采用普通产品身份认证，附加的任务运行期授权头会被拒绝。

## 请求

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 输入示例

```bash
curl --request DELETE \
  "$BASE_URL/sessions/$SESSION_ID" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID"
```

:::::
:::::{tab-item} 参数说明

| 参数 | 位置 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- | --- |
| `X-Workspace-ID` | 请求头 | string | 是 | 目标工作区 ID。 |
| `session_id` | 路径 | integer | 是 | 当前用户记录的正整数 ID。 |

返回 HTTP 200 和操作结果对象，不是 204。 删除会话记录后，消息、标签或文件是否清理须分别核对，不能从此成功响应推断完整级联清理。

:::::
::::::
:::::::

## 成功响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "message": "deleted"
  }
}
```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功为 OK；HTTP 状态码为 200。 |
| `msg` | string | 成功为 OK。 |
| `data.message` | string | 操作结果：pinned、unpinned 或 deleted。 |

:::::
::::::
:::::::

## 错误响应

[错误格式和结果确认](objects.md#error-contract)区分会话详情的 not-found 与其他入口的通用服务错误。
