文档中心

火山方舟

Agents

归档智能体

POST https://ark.cn-beijing.volces.com/api/v3/agents/{agent_id}/archive

当某个智能体不再用于创建新 Session，但仍需保留配置和历史版本供查询时，调用本接口将其归档。

归档后，该智能体不能再更新或用于创建新 Session，但详情和历史版本仍可查询。已有 Session 不受影响，继续使用创建时保存的配置快照。

本接口支持幂等调用；重复归档不会改变首次 archived_at。

鉴权

本接口支持鉴权方式如下，详情请参见 Base URL 及鉴权。

API Key 鉴权，请在 API Key 管理页面，获取长效 API Key。

请求参数

Path 参数

agent_id string 必选 | 智能体 ID

响应参数

created_at string | 创建时间

id string | 智能体 ID

name string | 智能体名称

type string | 对象类型

updated_at string | 更新时间

version integer | 版本号

archived_at string | 归档时间

base_agent string | 基础 Agent 类型

context_management object[] | 上下文管理

description string | 智能体描述

display_name string | 展示名称

mcp_servers object[] | MCP 服务列表

metadata object | 自定义元数据

model object | 模型配置

multiagent object | 多智能体配置

scene string | Agent 场景

skills object[] | 技能列表

system string | 系统提示词

tags object[] | 标签列表

*tools object[]  |  工具列表
*您为智能体配置的工具列表。
* 
* 
* 
* 
* 
* 
* 

*type string  |  工具类型
*tools.type
*工具类型。
*服务端可能返回兼容之前基础工具集的历史值。
*agent_toolset_20260916：使用方舟内置的 bash、edit、read、write、glob、grep、web_fetch 和 web_search 工具。
*agent_toolset_multimodal_20260825：使用 image_generate、video_generate、visual_search、general_search、compose_video 和 todo_write 工具。
*mcp_toolset：使用指定 MCP 服务提供的工具。
*custom：使用由客户端执行的自定义工具。

*configs object[]  |  工具配置列表
*tools.configs
*按工具名称设置工具的启用状态和权限策略。
* 
* 
* 
* 

*name string  |  工具名称
*tools.configs.name
*工具配置对应的工具名称。

*enabled boolean  |  是否启用
*tools.configs.enabled
*是否启用此工具。

*models object[]  |  工具模型列表
*tools.configs.models
*图片生成或视频生成工具实际绑定模型列表。
* 
* 
* 
* 

*id string  |  模型或接入点 ID
*tools.configs.models.id
*该工具绑定的模型 ID 或推理接入点 ID。

*default boolean  |  是否为默认模型
*tools.configs.models.default
*是否为该工具的默认模型。

*name string  |  模型名称
*tools.configs.models.name
*服务端根据模型 ID 或推理接入点 ID 返回的模型名称。

*version string  |  模型版本
*tools.configs.models.version
*服务端根据模型 ID 或推理接入点 ID 返回的模型版本。

*permission_policy object  |  权限策略
*tools.configs.permission_policy
*该工具使用的权限策略。
* 

*type string  |  策略类型
*tools.configs.permission_policy.type
*工具调用许可策略。
*always_allow：表示总是允许调用。
*always_ask：表示每次使用前需要确认。

*default_config object  |  默认工具配置
*tools.default_config
*未在 configs 中单独配置的工具所使用的默认启用状态和权限策略。
* 
* 

*enabled boolean  |  默认是否启用
*tools.default_config.enabled
*是否默认启用未在 configs 中单独配置的工具。
*true：表示默认启用。
*false：表示默认禁用。

*permission_policy object  |  默认权限策略
*tools.default_config.permission_policy
*未在 configs 中单独配置的工具所使用的默认权限策略。
* 

*type string  |  策略类型
*tools.default_config.permission_policy.type
*工具调用许可策略。
*always_allow：表示总是允许调用。
*always_ask：表示每次使用前需要确认。

*description string  |  自定义工具描述
*tools.description
*说明自定义工具的功能和适用场景，供模型判断何时调用该工具。

*input_schema object  |  输入参数定义
*tools.input_schema
*返回 Agent 中保存的自定义工具输入参数 JSON Schema。
* 
* 
* 

*properties object  |  参数属性定义
*tools.input_schema.properties
*返回 Agent 中保存的 JSON Schema 属性映射。每个键为参数名，每个值为对应参数的 JSON Schema 子对象。

*required string[]  |  必填参数名称列表
*tools.input_schema.required
*返回调用自定义工具时必须提供的参数名称列表。

*type string  |  Schema 类型
*tools.input_schema.type
*返回 JSON Schema 的顶层类型，固定为 object。

*mcp_server_name string  |  MCP 服务名称
*tools.mcp_server_name
*MCP 工具所属的 MCP 服务名称。

*name string  |  自定义工具名称
*tools.name
*自定义工具的名称。

tools object[] | 工具列表

configs object[] | 工具配置列表

default_config object | 默认工具配置

归档智能体

发起调试等同于请求真实调用，可能产生云产品费用，请谨慎操作！

Request

curl -sS --fail-with-body \
  "https://ark.cn-beijing.volces.com/api/v3/agents/<AGENT_ID>/archive" \
  -H "Authorization: Bearer $ARK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

{
  "id": "<AGENT_ID>",
  "type": "agent",
  "name": "<AGENT_NAME>",
  "model": {
    "id": "doubao-seed-2-1-pro-260915"
  },
  "version": 3,
  "created_at": "2026-10-20T08:00:00Z",
  "updated_at": "2026-10-26T09:15:00Z",
  "archived_at": "2026-10-26T09:15:00Z"
}

最近更新时间：2026.10.30 21:22:59

这个页面对您有帮助吗？

有用

无用