面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/archive-agent-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

归档智能体

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

要归档的智能体 ID,以 agent- 开头。可从创建智能体响应或智能体列表中获取。

响应参数#

created_at string  |  创建时间

智能体创建时间,采用 RFC 3339 格式的 UTC 时间。

id string  |  智能体 ID

智能体唯一标识,以 agent- 开头。更新或删除智能体,以及创建会话时,需要使用该值。

name string  |  智能体名称

用于识别和管理智能体的名称。

type string  |  对象类型

返回对象的类型,表示该对象为智能体。

取值固定为 agent。

updated_at string  |  更新时间

智能体最后更新时间,采用 RFC 3339 格式的 UTC 时间。

version integer  |  版本号

当前智能体配置的版本号。

archived_at string  |  归档时间

智能体首次归档的时间,采用 RFC 3339 格式的 UTC 时间。归档接口成功后返回该字段;重复归档时保持不变。

base_agent string  |  基础 Agent 类型

智能体创建时确定的基础 Agent 类型。

  • ark_agent_preview:通用 Agent。
  • ultra_vision_agent_preview:Seedance Managed Agent。
context_management object[]  |  上下文管理

智能体版本的上下文管理策略。

  • 未保存自定义策略,或已保存策略未包含 compact_threshold 时,响应展示平台当前默认压缩策略或默认阈值;当前默认阈值为 192000 token。
  • 响应中的默认展示值不会写回 Agent 版本。显式保存的 compact_threshold 优先返回。
type string  |  策略类型

context_management.type

策略类型,固定为 compaction。

compact_threshold integer  |  压缩阈值

context_management.compact_threshold

查询响应展示的自动压缩触发阈值,单位为 token。未显式保存时,对外接口响应会填充平台当前默认值,当前默认值为 192000;该展示值不会写回 Agent 版本或 Session 快照。

instructions string  |  摘要指令

context_management.instructions

用户配置的压缩摘要指令。

description string  |  智能体描述

智能体的用途、能力范围和适用场景。

display_name string  |  展示名称

智能体的展示名称。

mcp_servers object[]  |  MCP 服务列表

智能体已配置的 MCP 服务列表。

name string  |  MCP 服务名称

mcp_servers.name

用于标识 MCP 服务的名称。

type string  |  接入方式

mcp_servers.type

MCP 服务的接入方式。

取值固定为 url。

url string  |  服务地址

mcp_servers.url

MCP 服务的访问地址。

metadata object  |  自定义元数据

智能体的自定义键值对元数据。

model object  |  模型配置

智能体使用的模型配置。

id string  |  模型或接入点 ID

model.id

智能体调用的模型 ID 或推理接入点 ID。例如模型 ID doubao-seed-2-1-pro-260628,或推理接入点 ID ep-20260907123456-abcd1。

reasoning_effort string  |  推理投入档位

model.reasoning_effort

模型在深度思考时使用的推理投入档位。可选值:none、minimal、low、medium、high、xhigh、max。

service_tier string  |  推理服务档位

model.service_tier

模型调用使用的推理服务档位。可选值:auto、default、fast。

speed string  |  推理速度档位

model.speed

模型使用的推理速度档位。可选值:standard、fast。

thinking string  |  深度思考

model.thinking

模型的深度思考模式。auto 表示由模型决定是否启用深度思考。取值:enabled / disabled / auto。

multiagent object  |  多智能体配置

智能体与子智能体之间的协作配置。

agents object[]  |  子智能体列表

multiagent.agents

参与协作的子智能体列表。

type string  |  子智能体来源

multiagent.agents.type

子智能体的来源。agent 表示引用已存在的智能体;self 表示复用当前智能体配置作为子智能体参与协作。

id string  |  智能体 ID

multiagent.agents.id

被引用智能体的 ID。

version integer  |  智能体版本

multiagent.agents.version

被引用智能体的版本号。

type string  |  协作模式

multiagent.type

多智能体协作模式,取值固定为 coordinator。当前智能体负责分配任务并汇总子智能体的结果。

scene string  |  Agent 场景

Agent 场景标记。

  • default:普通 Agent。
  • dreams:用于 Dream 记忆整理任务的 Agent。
skills object[]  |  技能列表

智能体已绑定的技能列表。

type string  |  技能来源

skills.type

技能来源。

  • ark:方舟预置技能。
  • skill_hub:来自 SkillHub 的公共技能。
  • custom:当前账号通过 Skills API 创建的自定义技能。
skill_id string  |  技能 ID

skills.skill_id

绑定到智能体的技能 ID。

version string  |  技能版本

skills.version

绑定到智能体的技能版本号。

system string  |  系统提示词

您为智能体配置并保存的系统提示词,用于定义智能体的角色和行为要求。

tags object[]  |  标签列表

智能体的标签列表。

key string  |  标签键

tags.key

标签键,用于分类和检索。

value string  |  标签值

tags.value

标签对应的值。

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

自定义工具的名称。