跳转到主要内容

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 直接获取。

请求头

头部必选说明
AuthorizationBearer <PAT>

路径参数

参数类型必选说明
agent_idstringAgent 唯一标识

请求体

无需请求体。

示例请求

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 字段会更新为归档操作的时间。
字段类型说明
typestring固定值 "agent"
idstringAgent 唯一标识
namestringAgent 名称
descriptionstringAgent 描述
modelstring模型标识
systemstring系统提示词
instructionsstring指令内容
toolsarray工具配置列表
mcp_serversarrayMCP 服务器配置
default_environmentstring默认运行环境
versioninteger当前版本号
created_atstring创建时间(ISO 8601)
updated_atstring最后更新时间(ISO 8601),归档时刷新

错误码

HTTPtype触发条件
401authentication_errorPAT 无效或过期
403permission_error无权限归档此 Agent
404not_found_error指定 ID 的 Agent 不存在

归档与删除的区别

操作效果可恢复
归档(archive)Agent 从默认列表隐藏,数据保留是(可取消归档)
删除(delete)Agent 数据永久删除

注意事项

  • 归档是一个软删除操作,Agent 数据仍然保留在系统中
  • 归档后的 Agent 不会出现在 GET /v1/agents 的默认列表中
  • 仍可通过 GET /v1/agents/{agent_id} 直接访问已归档的 Agent
  • 归档操作是幂等的,重复归档不会报错