# 取消智能体候选方案

取消一个尚未确认的智能体候选方案。

```text
POST https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/agent-builder/candidates/{agent_id}/candidate-versions/{candidate_version}/cancel
```

## 调用前准备

先[生成智能体候选方案](propose-candidate.md)或[重新生成智能体候选方案](repropose-candidate.md)，取得候选版本和 `source_digest`。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID、智能体 ID 和候选版本。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递，同时作为路径中的 `workspace_id`。
- `$AGENT_ID`：智能体 ID，作为路径中的 `agent_id`。
- `$CANDIDATE_VERSION`：要取消的候选版本，作为路径中的 `candidate_version`。
- `$SOURCE_DIGEST`：当前候选响应中的摘要，用于请求体中的 `source_digest`。

## 路径参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `workspace_id` | string | 是 | 工作区 ID。 |
| `agent_id` | string | 是 | 智能体 ID。 |
| `candidate_version` | string | 是 | 候选版本。 |

## 请求体

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `source_digest` | string | 是 | 当前候选响应中的摘要。 |

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/agent-builder/candidates/$AGENT_ID/candidate-versions/$CANDIDATE_VERSION/cancel" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "source_digest": "'"$SOURCE_DIGEST"'"
  }'
```

## 成功响应

成功时返回 `200`。`data` 返回取消后的候选方案；`status` 为 `superseded`。

```json
{
  "code": 0,
  "data": {
    "workspace_id": "ws_01",
    "agent_id": "agent_01",
    "candidate_version": "cand_01",
    "source_digest": "sha256:<HEX_DIGEST>",
    "status": "superseded",
    "display": {
      "agent_name": "产品助手"
    },
    "diagnostics": []
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功时为 `0`。 |
| `data.workspace_id` | string | 候选所属的工作区、智能体和候选版本。 |
| `data.agent_id` | string | 候选所属的工作区、智能体和候选版本。 |
| `data.candidate_version` | string | 候选所属的工作区、智能体和候选版本。 |
| `data.source_digest` | string | 被取消候选的内容摘要。 |
| `data.status` | string | 成功时为 `superseded`。 |
| `data.display` | object | 候选展示内容、诊断和已解析资源引用。 |
| `data.diagnostics` | array | 候选展示内容、诊断和已解析资源引用。 |
| `data.resolved_refs` | object | 候选展示内容、诊断和已解析资源引用。 |

## 错误响应

```json
{
  "code": 4,
  "message": "<错误信息>"
}
```

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `2`（`INVALID_ARGUMENT`）
  - 请求包含未知字段或 `source_digest` 无效。
  - 检查请求体。
* - `401`
  - `6`（`UNAUTHENTICATED`）
  - 缺少有效身份凭据。
  - 检查 API Key。
* - `403`
  - `5`（`PERMISSION_DENIED`）
  - 当前身份没有取消候选的权限。
  - 检查工作区和智能体授权。
* - `404`
  - `3`（`NOT_FOUND`）
  - 候选版本不存在。
  - 检查候选版本。
* - `409`
  - `4`（`ALREADY_EXISTS`）
  - 摘要不匹配、候选已被替换，或当前状态不允许取消。
  - 获取最新候选后重试。
* - `500`
  - `1`（`INTERNAL`）
  - 取消候选时发生内部错误。
  - 稍后重试。
* - `503`
  - `15`（`UNAVAILABLE`）
  - 智能体搭建或授权服务暂不可用。
  - 稍后重试。
```

## 后续操作

需要继续搭建时[生成智能体候选方案](propose-candidate.md)。