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

更新智能体

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

更新指定智能体的配置信息。请求中的 version 必须与智能体当前版本一致;不一致时,服务端拒绝本次更新并返回 400 InvalidParameter。

除 version 外,省略任一可选请求字段或传 null 时保留原值;各字段的清空和整体替换规则见请求参数。

  • 仅更新 display_name 时不创建新版本,响应中的 version 保持不变;更新其他配置时会生成新版本。
  • 创建智能体后,后续创建的会话会自动使用更新后的版本,但之前已创建的会话将继续使用创建时的智能体版本。
  • base_agent 在创建后不能修改,已创建的通用 Agent 不能通过更新接口变更为视觉增强 Agent。

鉴权#

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

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

请求参数#

Path 参数#

agent_id string 必选  |  智能体 ID

要更新的智能体 ID。通过创建智能体接口 (POST /agents) 返回, 或在控制台智能体列表页面获取。

Body 参数#

version integer 必选  |  版本号

当前智能体的版本号。更新前可调用查询智能体详情接口获取最新版本号。

服务端会校验该值是否与当前版本一致;不一致时,服务端拒绝本次更新。

  • 省略或不大于 0:返回 400 MissingParameter。
  • 与智能体当前版本不一致:返回 400 InvalidParameter,错误消息为 version: conflict。
description string  |  智能体描述

智能体描述,用于说明智能体的用途、能力范围和适用场景,最多 2048 字符。省略或传 null 时保留原值,传空字符串 "" 时清空。

display_name string  |  展示名称

智能体展示名称,最多 256 个字符。省略或传 null 时保留原值,传空字符串 "" 时清空。

mcp_servers object[]  |  MCP 服务配置

MCP 服务配置列表,最多 20 项。

  • 省略或传 null:保留原值。
  • 传空数组 []:清空。
  • 传非空数组:整体替换。
type string 必选  |  接入方式

mcp_servers.type

MCP 服务的接入方式。

取值固定为 url。

url string 必选  |  服务地址

mcp_servers.url

MCP 服务的访问地址。同一智能体内不能配置重复的 MCP 服务地址。

name string  |  MCP 服务名称

mcp_servers.name

MCP 服务名称,最长 255 个字符,用于在当前 Agent 中识别该服务;配置 MCP 工具集时,tools[].mcp_server_name 必须填写此名称。

  • 省略名称或名称不符合命名规则时,服务端根据 url 生成名称。
  • 服务端会将符合命名规则的名称转换为小写。
  • 多个名称冲突时,服务端为后续名称添加数字后缀。
metadata object  |  自定义元数据

用户自定义键值对元数据,最多 16 对,键最多 64 字符,值最多 512 字符。

  • 省略或传 null:保留原值。
  • 传入非空对象:整体替换;如需保留已有键,先查询并合并后再传。
  • 传入空对象 {}:清空。
model object  |  模型配置

智能体使用的模型配置,包含模型 ID 或推理接入点 ID,以及运行参数。

  • 各运行参数的支持范围和默认行为以所选模型为准。
  • 传入模型不支持的取值时,服务端返回 400 InvalidParameter。
  • 省略或传 null:保留原配置。
  • 不支持清空模型配置。
  • 修改视觉增强 Agent 的 model.id 时,从控制台的视觉增强 Agent 创建页面展示的模型中选择;本文不固定具体模型 ID。
  • 所选模型必须支持 Managed Agent 推理和 reasoning_effort: high。reasoning_effort 只能设置为 high;省略时保留当前的 high。
  • 详情请参见 模型支持的参数列表。
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  |  多智能体配置

多智能体协作配置,最多支持 20 个子智能体。

省略或传 null 时保留原配置。

agents object[] 必选  |  子智能体列表

multiagent.agents

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

type string 必选  |  子智能体来源

multiagent.agents.type

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

id string  |  智能体 ID

multiagent.agents.id

被引用智能体的 ID。type 为 agent 时,用于指定参与协作的已有智能体,必须填写;type 为 self 时,当前智能体使用自身配置参与协作,不填写该字段。

version integer  |  智能体版本

multiagent.agents.version

被引用智能体的版本号。省略时使用最新版本。

type string 必选  |  协作模式

multiagent.type

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

name string  |  智能体名称

智能体名称,长度为 1~256 个字符。省略或传 null 时保留原值,不支持清空。

skills object[]  |  技能配置

技能配置列表,最多支持 50 个技能。未指定技能版本时,使用该技能的最新版本。

  • 省略或传 null:保留原值。
  • 传空数组 []:清空。
  • 传非空数组:整体替换。
skill_id string 必选  |  技能 ID

skills.skill_id

要绑定到智能体的技能 ID。

type string 必选  |  技能来源

skills.type

技能来源。

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

skills.version

要绑定的技能版本号。省略时使用该技能的最新版本。

system string  |  系统提示词

系统提示词,定义智能体的角色和行为规则,最多 100000 字符。省略或传 null 时保留原值,传空字符串 "" 时清空。

更新视觉增强 Agent 时,该字段用于调整视觉创作任务中的角色、工作方式和输出要求。

tags object[]  |  标签列表

自定义标签列表,最多填写 50 项。同一请求内,标签键不能重复。

  • 省略或传 null:保留原值。
  • 传空数组 []:清空。
  • 传非空数组:整体替换。
key string 必选  |  标签键

tags.key

标签键,用于分类和检索,长度为 1~128 个字符,且不能以 volc: 或 maas: 开头。

value string  |  标签值

tags.value

标签对应的值,最长 256 个字符。

tools object[]  |  工具配置

工具配置列表,最多支持 128 个工具。

  • 内置工具集和 MCP 工具可通过 configs 和 default_config 设置启用状态及权限策略。
  • MCP 工具通过 mcp_server_name 关联 mcp_servers[].name。
  • 自定义工具需填写名称、功能描述和输入参数定义。
  • 省略或传 null:保留原值。
  • 传空数组 []:清空。
  • 传非空数组:整体替换。
  • 更新视觉增强 Agent 的工具配置时,更新后的完整配置仍须同时包含基础工具集和多模态工具集。基础工具集使用 agent_toolset_20260916;多模态工具集使用 agent_toolset_multimodal_20260825。
  • 多模态工具集中必须启用 image_generate、visual_search、general_search 和 compose_video;video_generate 可按需启用。
  • 启用 general_search 时,必须关闭基础工具集中的 web_search。
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:使用由客户端执行的自定义工具。
    可选值:agent_toolset_20260401、agent_toolset_20260701、agent_toolset_20260916、agent_toolset_multimodal_20260825、mcp_toolset、custom。
configs object[]  |  工具配置列表

tools.configs

按工具名称设置工具的启用状态和权限策略。

name string 必选  |  工具名称

tools.configs.name

工具配置对应的工具名称。

enabled boolean  |  是否启用

tools.configs.enabled

是否启用此工具。

models object[]  |  工具模型列表

tools.configs.models

图片生成或视频生成工具绑定的模型 ID 或推理接入点 ID 列表。省略时,服务端为已启用但未指定模型的生成工具绑定平台默认模型,并在响应中返回实际绑定结果。

id string 必选  |  模型或接入点 ID

tools.configs.models.id

图片生成或视频生成工具调用的模型 ID 或推理接入点 ID。

default boolean 默认值 false  |  是否为默认模型

tools.configs.models.default

是否作为该工具的默认模型。配置多个模型或接入点时,必须且只能将一项设置为 true。

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 默认值 true  |  是否启用

tools.default_config.enabled

是否默认启用未在 configs 中单独配置的工具。

  • true:表示默认启用。
  • false:表示默认禁用。
permission_policy object  |  权限策略

tools.default_config.permission_policy

未单独配置的工具所使用的默认权限策略。

type string 必选  |  策略类型

tools.default_config.permission_policy.type

工具调用许可策略。

  • always_allow:表示总是允许调用。
  • always_ask:表示每次使用前需要确认。
description string  |  自定义工具描述

tools.description

说明自定义工具的功能和适用场景,供模型判断何时调用该工具。

input_schema object  |  输入参数定义

tools.input_schema

定义自定义工具的输入参数及其约束。

properties object  |  参数属性定义

tools.input_schema.properties

自定义工具输入参数的 JSON Schema 属性映射。键为参数名,值为对应参数的 JSON Schema 子对象。请确保每个属性定义均符合 JSON Schema。

常用关键字包括:

  • type:参数类型,如 string、number、integer、boolean、array 或 object。
  • description:参数的用途说明,供模型理解并生成参数。
  • enum:参数允许使用的值。
  • items:数组元素的 JSON Schema。
  • properties、required:对象的子字段及必填字段。
  • minimum、maximum:数值参数的取值范围。

示例:

JSON
{ "city": { "type": "string", "description": "城市名称" }, "hours": { "type": "integer", "description": "预报时长,单位为小时", "minimum": 1, "maximum": 72 } }
required string[]  |  必填参数名称列表

tools.input_schema.required

自定义工具输入中必填的参数名称列表。列表中的每个名称必须与 properties 中定义的参数名称一致。

type string 默认值 object  |  Schema 类型

tools.input_schema.type

指定 JSON Schema 的顶层类型,仅支持 object。

mcp_server_name string  |  MCP 服务名称

tools.mcp_server_name

MCP 工具所属的 MCP 服务名称。

name string  |  自定义工具名称

tools.name

自定义工具的名称。

响应参数#

created_at string  |  创建时间

智能体创建时间。

id string  |  智能体 ID

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

name string  |  智能体名称

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

type string  |  对象类型

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

取值固定为 agent。

updated_at string  |  更新时间

智能体最后更新时间。

version integer  |  版本号

更新后的智能体配置版本号。

base_agent string  |  基础 Agent 类型

智能体创建时确定的基础 Agent 类型。该字段不能通过更新接口修改。 视觉增强 Agent 返回 ultra_vision_agent_preview。
可选值:ark_agent_preview、ultra_vision_agent_preview。

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。当前智能体负责分配任务并汇总子智能体的结果。

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:使用由客户端执行的自定义工具。
    可选值:agent_toolset_20260401、agent_toolset_20260701、agent_toolset_20260916、agent_toolset_multimodal_20260825、mcp_toolset、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

未单独配置的工具所使用的默认权限策略。

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

自定义工具的名称。