BIbigmodel
Managed Agents - Environment

更新 Environment

Changed on

更新指定 Environment 的名称、说明、元数据或云端配置。未提供的字段保持不变；归档后的 Environment 不能再绑定到新的 Session 或 Deployment。

post/agent/managed/v1/environments/{environmentId}

Request

  • Base URL
    https://agent-api.bigmodel.cn/api
  • Auth
    HTTP bearer

Path parameters

environmentIdstring required

environmentId 资源标识。

Headers

zai-version'2026-05-26' required
Example:2026-05-26

Managed Agents API 入口要求的基础协议标识，当前只接受 2026-05-26；响应兼容形态由 zai-beta 选择。两个头均需携带。

zai-betastring required
Example:managed-agents-2026-09-22

声明 Managed Agents Beta 协议并选择响应字段与兼容行为。新接入使用 managed-agents-2026-09-22；旧客户端仍可使用 managed-agents-2026-05-26。必须同时携带 zai-version: 2026-05-26。字段差异见 /cn/managed-agents/protocol-versions。

Request body

namestring

替换名称；省略时保持不变。

descriptionstring nullable

替换用途说明；null 表示清空，省略时保持不变。

metadataManagedMetadataPatch nullable

元数据补丁；省略整个字段时保持不变，键值为 null 时删除对应键。最多 16 个键，键名长度不超过 64 字符，字符串值不超过 512 字符。

scope'organization' nullable

只能为 organization；null 或省略不会改变现有作用域。

Response

请求成功。

idstring required

Environment ID。

type'environment' required
namestring required
descriptionstring nullable required

用途说明。

metadataManagedMetadata required

客户端自定义元数据；省略时默认为空对象。最多 16 个键，键名长度不超过 64 字符，值必须是长度不超过 512 字符的字符串。

scope'organization' required
state'active' | 'archived' required
archived_atstring nullable required

归档时间。

created_atstring date-time required

创建时间。

updated_atstring date-time required

更新时间。

Example response

{
  "id": "env_019e8f00-1ac2-7a6b-8000-3f2d5c8b9a01"
}

Changes