---
orphan: true
---

# 查询系统智能体配置

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

查询指定系统智能体在工作区中的配置。

```text
GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/system-agent-setups/{agent_id}
```

## 调用前准备

下方示例使用 `$AI_STUDIO_API_KEY`（个人访问令牌）、`$WORKSPACE_ID`（工作区 ID）和 `$AGENT_ID`（系统智能体 ID）。

## 请求示例

示例中的凭据和资源标识需替换为当前调用者的实际值。

```bash
curl "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/system-agent-setups/$AGENT_ID" -H "X-API-Key: $AI_STUDIO_API_KEY" -H "X-Workspace-ID: $WORKSPACE_ID"
```

<span id="请求参数"></span>

## 路径参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `workspace_id` | string | 是 | 所属工作区ID。 |
| `agent_id` | string | 是 | 系统智能体 ID。 |

agent_id 仅接受 github-issue-operator、github-pr-reviewer、ops-agent。GitHub 项目查询仅适用于前两个智能体。

## 成功响应

请求成功时返回 HTTP 200，响应如下。

```json
{
  "code": 0,
  "data": {
    "workspace_id": "",
    "agent_id": "agent_01",
    "name": "",
    "description": "",
    "definition": {
      "agent_id": "",
      "name": "",
      "description": "",
      "channel_slots": [],
      "knowledge_slots": []
    },
    "configured": false,
    "enabled": false,
    "channels": {},
    "knowledge_bases": {},
    "model": {},
    "callback_rule_enabled": false,
    "callback_configured": false,
    "callback_enabled": false
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `data.workspace_id` | string | 所属工作区ID。 |
| `data.agent_id` | string | 系统智能体 ID。 |
| `data.name` | string | 名称。 |
| `data.description` | string | 说明。 |
| `data.definition` | object | 内置智能体定义。 |
| `data.definition.agent_id` | string | 智能体ID。 |
| `data.definition.name` | string | 名称。 |
| `data.definition.description` | string | 说明。 |
| `data.definition.channel_slots` | object（对象数组） | 通道槽。 |
| `data.definition.channel_slots[].key` | string | 键。 |
| `data.definition.channel_slots[].name` | string | 名称。 |
| `data.definition.channel_slots[].description` | string | 说明。 无值时可省略。 |
| `data.definition.channel_slots[].provider` | string | 提供方；取值：`wecom`、`github`、`feishu`、`slack`、`grafana`、`kubernetes`、`qq_mail`、`codex`、`bocha`、`tavily`、`brave`。 |
| `data.definition.channel_slots[].channel_type` | string | 通道类型；取值：`wecom_app`、`wecom_group_robot`、`wecom_mail`、`github_app`、`feishu_app`、`slack_app`、`grafana`、`kubernetes`、`qq_mail`、`codex_api`、`bocha_web_search`、`tavily_web_search`、`brave_web_search`。 |
| `data.definition.channel_slots[].required` | boolean | 是否为必需槽。 |
| `data.definition.knowledge_slots` | object（对象数组） | 知识库槽。 |
| `data.definition.knowledge_slots[].key` | string | 键。 |
| `data.definition.knowledge_slots[].name` | string | 名称。 |
| `data.definition.knowledge_slots[].description` | string | 说明。 无值时可省略。 |
| `data.definition.knowledge_slots[].required` | boolean | 是否为必需槽。 |
| `data.definition.knowledge_slots[].compatible_table_names` | string（字符串数组） | 兼容的表名称列表。 无值时可省略。 |
| `data.definition.project_scope` | object | GitHub项目范围。 无值时可省略。 |
| `data.definition.project_scope.name` | string | 名称。 |
| `data.definition.project_scope.description` | string | 说明。 无值时可省略。 |
| `data.definition.project_scope.channel_slot_key` | string | 通道槽键。 |
| `data.definition.project_scope.required` | boolean | 是否为必需槽。 |
| `data.definition.suite_scope` | object | 运维套件范围。 无值时可省略。 |
| `data.definition.suite_scope.name` | string | 名称。 |
| `data.definition.suite_scope.description` | string | 说明。 无值时可省略。 |
| `data.definition.suite_scope.required` | boolean | 是否为必需槽。 |
| `data.configured` | boolean | 是否已配置。 |
| `data.enabled` | boolean | 是否启用。 |
| `data.channels` | object | 通道槽配置。 |
| `data.channels.repository` | object 或 null | 仓库名称。 无值时可省略。 |
| `data.channels.repository.id` | string | 标识。 |
| `data.channels.repository.workspace_id` | string | 所属工作区ID。 |
| `data.channels.repository.provider` | string | 提供方；取值：`wecom`、`github`、`feishu`、`slack`、`grafana`、`kubernetes`、`qq_mail`、`codex`、`bocha`、`tavily`、`brave`。 |
| `data.channels.repository.channel_type` | string | 通道类型；取值：`wecom_app`、`wecom_group_robot`、`wecom_mail`、`github_app`、`feishu_app`、`slack_app`、`grafana`、`kubernetes`、`qq_mail`、`codex_api`、`bocha_web_search`、`tavily_web_search`、`brave_web_search`。 |
| `data.channels.repository.name` | string | 名称。 |
| `data.channels.repository.description` | string | 说明。 无值时可省略。 |
| `data.channels.repository.status` | string | 状态；取值：`draft`、`active`、`disabled`、`archived`。 |
| `data.channels.repository.credential_ref` | string | 凭据引用。 |
| `data.channels.repository.callback_path` | string | 回调路径。 无值时可省略。 |
| `data.channels.repository.capabilities` | string（字符串数组） | 可用管理动作。 无值时可省略。 |
| `data.channels.repository.tool_ids` | string（字符串数组） | 工具ID列表。 无值时可省略。 |
| `data.channels.repository.config` | 任意 JSON | 配置。 无值时可省略。 |
| `data.channels.repository.last_test_status` | string | 最近连接测试状态；取值：`succeeded`、`failed`。 无值时可省略。 |
| `data.channels.repository.last_tested_at` | string | 最近连接测试时间；RFC 3339 时间。 无值时可省略。 |
| `data.channels.repository.last_test_error` | string | 最近连接测试错误。 无值时可省略。 |
| `data.channels.repository.labels` | 任意 JSON | 标签映射。 无值时可省略。 |
| `data.channels.repository.created_at` | string | 创建时间；RFC 3339 时间。 |
| `data.channels.repository.updated_at` | string | 更新时间；RFC 3339 时间。 |
| `data.channels.code_analysis` | object 或 null | 代码分析槽。 无值时可省略。 |
| `data.channels.code_analysis.id` | string | 标识。 |
| `data.channels.code_analysis.workspace_id` | string | 所属工作区ID。 |
| `data.channels.code_analysis.provider` | string | 提供方；取值：`wecom`、`github`、`feishu`、`slack`、`grafana`、`kubernetes`、`qq_mail`、`codex`、`bocha`、`tavily`、`brave`。 |
| `data.channels.code_analysis.channel_type` | string | 通道类型；取值：`wecom_app`、`wecom_group_robot`、`wecom_mail`、`github_app`、`feishu_app`、`slack_app`、`grafana`、`kubernetes`、`qq_mail`、`codex_api`、`bocha_web_search`、`tavily_web_search`、`brave_web_search`。 |
| `data.channels.code_analysis.name` | string | 名称。 |
| `data.channels.code_analysis.description` | string | 说明。 无值时可省略。 |
| `data.channels.code_analysis.status` | string | 状态；取值：`draft`、`active`、`disabled`、`archived`。 |
| `data.channels.code_analysis.credential_ref` | string | 凭据引用。 |
| `data.channels.code_analysis.callback_path` | string | 回调路径。 无值时可省略。 |
| `data.channels.code_analysis.capabilities` | string（字符串数组） | 可用管理动作。 无值时可省略。 |
| `data.channels.code_analysis.tool_ids` | string（字符串数组） | 工具ID列表。 无值时可省略。 |
| `data.channels.code_analysis.config` | 任意 JSON | 配置。 无值时可省略。 |
| `data.channels.code_analysis.last_test_status` | string | 最近连接测试状态；取值：`succeeded`、`failed`。 无值时可省略。 |
| `data.channels.code_analysis.last_tested_at` | string | 最近连接测试时间；RFC 3339 时间。 无值时可省略。 |
| `data.channels.code_analysis.last_test_error` | string | 最近连接测试错误。 无值时可省略。 |
| `data.channels.code_analysis.labels` | 任意 JSON | 标签映射。 无值时可省略。 |
| `data.channels.code_analysis.created_at` | string | 创建时间；RFC 3339 时间。 |
| `data.channels.code_analysis.updated_at` | string | 更新时间；RFC 3339 时间。 |
| `data.channels.notification` | object 或 null | 个人通知槽。 无值时可省略。 |
| `data.channels.notification.id` | string | 标识。 |
| `data.channels.notification.workspace_id` | string | 所属工作区ID。 |
| `data.channels.notification.provider` | string | 提供方；取值：`wecom`、`github`、`feishu`、`slack`、`grafana`、`kubernetes`、`qq_mail`、`codex`、`bocha`、`tavily`、`brave`。 |
| `data.channels.notification.channel_type` | string | 通道类型；取值：`wecom_app`、`wecom_group_robot`、`wecom_mail`、`github_app`、`feishu_app`、`slack_app`、`grafana`、`kubernetes`、`qq_mail`、`codex_api`、`bocha_web_search`、`tavily_web_search`、`brave_web_search`。 |
| `data.channels.notification.name` | string | 名称。 |
| `data.channels.notification.description` | string | 说明。 无值时可省略。 |
| `data.channels.notification.status` | string | 状态；取值：`draft`、`active`、`disabled`、`archived`。 |
| `data.channels.notification.credential_ref` | string | 凭据引用。 |
| `data.channels.notification.callback_path` | string | 回调路径。 无值时可省略。 |
| `data.channels.notification.capabilities` | string（字符串数组） | 可用管理动作。 无值时可省略。 |
| `data.channels.notification.tool_ids` | string（字符串数组） | 工具ID列表。 无值时可省略。 |
| `data.channels.notification.config` | 任意 JSON | 配置。 无值时可省略。 |
| `data.channels.notification.last_test_status` | string | 最近连接测试状态；取值：`succeeded`、`failed`。 无值时可省略。 |
| `data.channels.notification.last_tested_at` | string | 最近连接测试时间；RFC 3339 时间。 无值时可省略。 |
| `data.channels.notification.last_test_error` | string | 最近连接测试错误。 无值时可省略。 |
| `data.channels.notification.labels` | 任意 JSON | 标签映射。 无值时可省略。 |
| `data.channels.notification.created_at` | string | 创建时间；RFC 3339 时间。 |
| `data.channels.notification.updated_at` | string | 更新时间；RFC 3339 时间。 |
| `data.channels.group_notification` | object 或 null | 群通知槽。 无值时可省略。 |
| `data.channels.group_notification.id` | string | 标识。 |
| `data.channels.group_notification.workspace_id` | string | 所属工作区ID。 |
| `data.channels.group_notification.provider` | string | 提供方；取值：`wecom`、`github`、`feishu`、`slack`、`grafana`、`kubernetes`、`qq_mail`、`codex`、`bocha`、`tavily`、`brave`。 |
| `data.channels.group_notification.channel_type` | string | 通道类型；取值：`wecom_app`、`wecom_group_robot`、`wecom_mail`、`github_app`、`feishu_app`、`slack_app`、`grafana`、`kubernetes`、`qq_mail`、`codex_api`、`bocha_web_search`、`tavily_web_search`、`brave_web_search`。 |
| `data.channels.group_notification.name` | string | 名称。 |
| `data.channels.group_notification.description` | string | 说明。 无值时可省略。 |
| `data.channels.group_notification.status` | string | 状态；取值：`draft`、`active`、`disabled`、`archived`。 |
| `data.channels.group_notification.credential_ref` | string | 凭据引用。 |
| `data.channels.group_notification.callback_path` | string | 回调路径。 无值时可省略。 |
| `data.channels.group_notification.capabilities` | string（字符串数组） | 可用管理动作。 无值时可省略。 |
| `data.channels.group_notification.tool_ids` | string（字符串数组） | 工具ID列表。 无值时可省略。 |
| `data.channels.group_notification.config` | 任意 JSON | 配置。 无值时可省略。 |
| `data.channels.group_notification.last_test_status` | string | 最近连接测试状态；取值：`succeeded`、`failed`。 无值时可省略。 |
| `data.channels.group_notification.last_tested_at` | string | 最近连接测试时间；RFC 3339 时间。 无值时可省略。 |
| `data.channels.group_notification.last_test_error` | string | 最近连接测试错误。 无值时可省略。 |
| `data.channels.group_notification.labels` | 任意 JSON | 标签映射。 无值时可省略。 |
| `data.channels.group_notification.created_at` | string | 创建时间；RFC 3339 时间。 |
| `data.channels.group_notification.updated_at` | string | 更新时间；RFC 3339 时间。 |
| `data.channels.observability` | object 或 null | 观测槽。 无值时可省略。 |
| `data.channels.observability.id` | string | 标识。 |
| `data.channels.observability.workspace_id` | string | 所属工作区ID。 |
| `data.channels.observability.provider` | string | 提供方；取值：`wecom`、`github`、`feishu`、`slack`、`grafana`、`kubernetes`、`qq_mail`、`codex`、`bocha`、`tavily`、`brave`。 |
| `data.channels.observability.channel_type` | string | 通道类型；取值：`wecom_app`、`wecom_group_robot`、`wecom_mail`、`github_app`、`feishu_app`、`slack_app`、`grafana`、`kubernetes`、`qq_mail`、`codex_api`、`bocha_web_search`、`tavily_web_search`、`brave_web_search`。 |
| `data.channels.observability.name` | string | 名称。 |
| `data.channels.observability.description` | string | 说明。 无值时可省略。 |
| `data.channels.observability.status` | string | 状态；取值：`draft`、`active`、`disabled`、`archived`。 |
| `data.channels.observability.credential_ref` | string | 凭据引用。 |
| `data.channels.observability.callback_path` | string | 回调路径。 无值时可省略。 |
| `data.channels.observability.capabilities` | string（字符串数组） | 可用管理动作。 无值时可省略。 |
| `data.channels.observability.tool_ids` | string（字符串数组） | 工具ID列表。 无值时可省略。 |
| `data.channels.observability.config` | 任意 JSON | 配置。 无值时可省略。 |
| `data.channels.observability.last_test_status` | string | 最近连接测试状态；取值：`succeeded`、`failed`。 无值时可省略。 |
| `data.channels.observability.last_tested_at` | string | 最近连接测试时间；RFC 3339 时间。 无值时可省略。 |
| `data.channels.observability.last_test_error` | string | 最近连接测试错误。 无值时可省略。 |
| `data.channels.observability.labels` | 任意 JSON | 标签映射。 无值时可省略。 |
| `data.channels.observability.created_at` | string | 创建时间；RFC 3339 时间。 |
| `data.channels.observability.updated_at` | string | 更新时间；RFC 3339 时间。 |
| `data.channels.kubernetes` | object 或 null | Kubernetes槽。 无值时可省略。 |
| `data.channels.kubernetes.id` | string | 标识。 |
| `data.channels.kubernetes.workspace_id` | string | 所属工作区ID。 |
| `data.channels.kubernetes.provider` | string | 提供方；取值：`wecom`、`github`、`feishu`、`slack`、`grafana`、`kubernetes`、`qq_mail`、`codex`、`bocha`、`tavily`、`brave`。 |
| `data.channels.kubernetes.channel_type` | string | 通道类型；取值：`wecom_app`、`wecom_group_robot`、`wecom_mail`、`github_app`、`feishu_app`、`slack_app`、`grafana`、`kubernetes`、`qq_mail`、`codex_api`、`bocha_web_search`、`tavily_web_search`、`brave_web_search`。 |
| `data.channels.kubernetes.name` | string | 名称。 |
| `data.channels.kubernetes.description` | string | 说明。 无值时可省略。 |
| `data.channels.kubernetes.status` | string | 状态；取值：`draft`、`active`、`disabled`、`archived`。 |
| `data.channels.kubernetes.credential_ref` | string | 凭据引用。 |
| `data.channels.kubernetes.callback_path` | string | 回调路径。 无值时可省略。 |
| `data.channels.kubernetes.capabilities` | string（字符串数组） | 可用管理动作。 无值时可省略。 |
| `data.channels.kubernetes.tool_ids` | string（字符串数组） | 工具ID列表。 无值时可省略。 |
| `data.channels.kubernetes.config` | 任意 JSON | 配置。 无值时可省略。 |
| `data.channels.kubernetes.last_test_status` | string | 最近连接测试状态；取值：`succeeded`、`failed`。 无值时可省略。 |
| `data.channels.kubernetes.last_tested_at` | string | 最近连接测试时间；RFC 3339 时间。 无值时可省略。 |
| `data.channels.kubernetes.last_test_error` | string | 最近连接测试错误。 无值时可省略。 |
| `data.channels.kubernetes.labels` | 任意 JSON | 标签映射。 无值时可省略。 |
| `data.channels.kubernetes.created_at` | string | 创建时间；RFC 3339 时间。 |
| `data.channels.kubernetes.updated_at` | string | 更新时间；RFC 3339 时间。 |
| `data.knowledge_bases` | object | 知识库引用。 |
| `data.model` | object | 模型。 |
| `data.model.model_config_ref` | string | 模型配置引用。 无值时可省略。 |
| `data.model.default_model` | string | 默认模型。 无值时可省略。 |
| `data.model.params_override` | 任意 JSON | 参数覆盖。 无值时可省略。 |
| `data.skill_refs` | object（对象数组） | 技能引用。 无值时可省略。 |
| `data.skill_refs[].id` | string | 标识。 |
| `data.skill_refs[].workspace_id` | string | 所属工作区ID。 无值时可省略。 |
| `data.skill_refs[].kind` | string | 类别；取值：`skill`、`tool`、`knowledge_base`。 |
| `data.skill_refs[].status` | string | 状态。 无值时可省略。 |
| `data.skill_refs[].resource_id` | string | 资源ID。 无值时可省略。 |
| `data.skill_refs[].name` | string | 名称。 无值时可省略。 |
| `data.skill_refs[].display_name` | string | 展示名称。 无值时可省略。 |
| `data.skill_refs[].description` | string | 说明。 无值时可省略。 |
| `data.skill_refs[].category` | string | 资源类别。 无值时可省略。 |
| `data.skill_refs[].phase` | string | 执行阶段。 无值时可省略。 |
| `data.skill_refs[].bindable` | boolean | 是否可绑定。 |
| `data.skill_refs[].bindability_reason` | string | 绑定可用性说明。 无值时可省略。 |
| `data.skill_refs[].supported_runtimes` | string（字符串数组） | 支持的运行环境。 无值时可省略。 |
| `data.skill_refs[].config` | 任意 JSON | 配置。 无值时可省略。 |
| `data.skill_refs[].runtime_tool_visibility` | string | 运行工具可见性。 无值时可省略。 |
| `data.skill_refs[].binding_source` | string | 绑定来源。 无值时可省略。 |
| `data.skill_refs[].manageable` | boolean | 是否可管理。 |
| `data.project_scope` | object | GitHub项目范围。 无值时可省略。 |
| `data.project_scope.project_id` | string | GitHub项目ID。 |
| `data.project_scope.owner` | string | 所有者。 |
| `data.project_scope.owner_type` | string | 所有者类型。 |
| `data.project_scope.number` | integer | 编号。 |
| `data.project_scope.title` | string | 标题。 |
| `data.project_scope.url` | string | 地址。 |
| `data.project_scope.host` | string | 主机。 无值时可省略。 |
| `data.suites` | object（对象数组） | 运维检查项。 无值时可省略。 |
| `data.suites[].suite_id` | string | 运维套件ID。 |
| `data.suites[].display_name` | string | 展示名称。 无值时可省略。 |
| `data.suites[].namespace` | string | Kubernetes命名空间。 |
| `data.suites[].log_namespace` | string | 日志命名空间。 无值时可省略。 |
| `data.suites[].containers` | string（字符串数组） | 容器列表。 无值时可省略。 |
| `data.suites[].enabled` | boolean | 是否启用。 无值时可省略。 |
| `data.reconciliation_task` | object | 协调任务。 无值时可省略。 |
| `data.reconciliation_task.id` | string | 标识。 无值时可省略。 |
| `data.reconciliation_task.status` | string | 状态；取值：`draft`、`creating`、`active`、`failed`、`disabled`、`archived`。 无值时可省略。 |
| `data.reconciliation_task.cron_expression` | string | Cron表达式。 |
| `data.capacity_patrol_task` | object | 容量巡检任务。 无值时可省略。 |
| `data.capacity_patrol_task.id` | string | 标识。 无值时可省略。 |
| `data.capacity_patrol_task.status` | string | 状态；取值：`draft`、`creating`、`active`、`failed`、`disabled`、`archived`。 无值时可省略。 |
| `data.capacity_patrol_task.cron_expression` | string | Cron表达式。 |
| `data.automation_task_id` | string | 自动化任务ID。 无值时可省略。 |
| `data.automation_task_status` | string | 自动化任务状态；取值：`draft`、`creating`、`active`、`failed`、`disabled`、`archived`。 无值时可省略。 |
| `data.callback_rule_id` | string | 回调规则ID。 无值时可省略。 |
| `data.callback_rule_enabled` | boolean | 回调规则是否启用。 |
| `data.callback_configured` | boolean | 回调是否已配置。 |
| `data.callback_enabled` | boolean | 回调是否启用。 |

字段路径中的 `[]` 表示数组中的每一项。

## 错误响应

不存在返回 HTTP 404/code=3；权限拒绝返回 HTTP 403/code=5。身份认证层的字符串错误代码需与业务层数字错误代码分开解析。

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

```json
{
  "code": 3,
  "message": "not found"
}
```

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

响应中的 `data.agent_id` 是系统智能体 ID；使用该 ID 继续更新配置或查询相关 GitHub 项目。

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