Documentation Index
Fetch the complete documentation index at: https://docs.qoder.com/llms.txt
Use this file to discover all available pages before exploring further.
POST /v1/agents/{agent_id}/archive
归档指定的 Agent。归档后 Agent 不会出现在默认列表中,但仍可通过 ID 直接获取。
请求头
| 头部 | 必选 | 说明 |
|---|
Authorization | 是 | Bearer <PAT> |
路径参数
| 参数 | 类型 | 必选 | 说明 |
|---|
agent_id | string | 是 | Agent 唯一标识 |
请求体
无需请求体。
示例请求
curl -X POST "https://openapi.qoder.sh/api/v1/cloud/agents/agent_019eXXXX.../archive" \
-H "Authorization: Bearer $QODER_PAT"
示例响应
HTTP 200 OK
{
"type": "agent",
"id": "agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"name": "doc-test-agent-updated",
"description": "用于 API 文档测试",
"model": "ultimate",
"system": "你是更新后的文档测试助手",
"instructions": "你是更新后的文档测试助手",
"tools": [],
"mcp_servers": [],
"default_environment": "",
"version": 2,
"created_at": "2026-05-18T15:26:39.61669Z",
"updated_at": "2026-05-18T15:27:22.698411Z"
}
响应字段
返回归档后的完整 Agent 对象。updated_at 字段会更新为归档操作的时间。
| 字段 | 类型 | 说明 |
|---|
type | string | 固定值 "agent" |
id | string | Agent 唯一标识 |
name | string | Agent 名称 |
description | string | Agent 描述 |
model | string | 模型标识 |
system | string | 系统提示词 |
instructions | string | 指令内容 |
tools | array | 工具配置列表 |
mcp_servers | array | MCP 服务器配置 |
default_environment | string | 默认运行环境 |
version | integer | 当前版本号 |
created_at | string | 创建时间(ISO 8601) |
updated_at | string | 最后更新时间(ISO 8601),归档时刷新 |
错误码
| HTTP | type | 触发条件 |
|---|
| 401 | authentication_error | PAT 无效或过期 |
| 403 | permission_error | 无权限归档此 Agent |
| 404 | not_found_error | 指定 ID 的 Agent 不存在 |
归档与删除的区别
| 操作 | 效果 | 可恢复 |
|---|
| 归档(archive) | Agent 从默认列表隐藏,数据保留 | 是(可取消归档) |
| 删除(delete) | Agent 数据永久删除 | 否 |
注意事项
- 归档是一个软删除操作,Agent 数据仍然保留在系统中
- 归档后的 Agent 不会出现在
GET /v1/agents 的默认列表中
- 仍可通过
GET /v1/agents/{agent_id} 直接访问已归档的 Agent
- 归档操作是幂等的,重复归档不会报错