POST https://ark.cn-beijing.volces.com/api/v3/sessions/{session_id}/archive
任务结束后,如果需要释放运行资源并保留会话配置和运行记录供查询,调用本接口归档会话。活跃会话的 status 必须为 idle(空闲);其他活跃状态不满足归档条件,接口返回 400 InvalidAction。如果服务端检测到状态为 queued(排队中)或 running(运行中)的工具任务,也会返回 InvalidAction;请等待任务结束或取消任务后重试。
status 为 idle 的会话归档成功后,服务端将其设为 terminated(已终止),在 archived_at 记录首次进入该状态的时间,并开始回收运行资源。
status 已为 terminated 的会话也可以调用本接口。重复调用时,已有的 archived_at 保持不变;对于归档功能上线前已经终止且缺少 archived_at 的历史会话,服务端不会用本次调用时间补写。
归档后的会话不能再更新、升级或写入事件,但配置和运行记录仍可查询。重复归档不会延长事件、Trace 记录以及图片、视频等媒体数据的保留期。
鉴权#
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。
- API Key 鉴权,请在 API Key 管理 页面,获取长效 API Key。
请求参数#
Path 参数#
session_id string 必选 | 会话 ID
要归档的会话 ID,以 sesn- 开头。可从创建会话响应或会话列表中获取。
响应参数#
agent object | 智能体信息
创建会话时保存的智能体配置快照,包含该会话实际使用的模型、系统提示词、工具、MCP 服务和技能等配置。后续更新智能体不会影响该会话中的快照。
created_at string | 创建时间
agent.created_at
智能体创建完成的时间,采用 RFC 3339 格式。
id string | 智能体 ID
agent.id
会话当前使用的智能体 ID。
name string | 智能体名称
agent.name
会话当前使用的智能体名称。
type string | 对象类型
agent.type
对象类型,固定为 agent。
updated_at string | 更新时间
agent.updated_at
智能体配置最后更新的时间,采用 RFC 3339 格式。
version integer | 版本号
agent.version
会话当前使用的智能体版本号。
base_agent string | 基础智能体类型
agent.base_agent
会话当前使用的基础 Agent 类型。
ark_agent_preview:通用 Agent。ultra_vision_agent_preview:Seedance Managed Agent。
context_management object[] | 上下文管理
agent.context_management
创建会话时冻结的上下文管理策略。Session 响应会在快照未保存自定义策略或已保存策略未包含 compact_threshold 时,展示平台当前默认压缩策略或默认阈值;当前默认阈值为 192000 token。
响应中的默认展示值不会写回 Session 快照。显式保存的 compact_threshold 优先返回。
type string | 策略类型
agent.context_management.type
策略类型,固定为 compaction。
compact_threshold integer | 压缩阈值
agent.context_management.compact_threshold
查询响应展示的自动压缩触发阈值,单位为 token。未显式保存时,对外接口响应会填充平台当前默认值,当前默认值为 192000;该展示值不会写回 Agent 版本或 Session 快照。
instructions string | 摘要指令
agent.context_management.instructions
用户配置的压缩摘要指令。
description string | 智能体说明
agent.description
会话当前使用的智能体说明。
display_name string | 显示名称
agent.display_name
会话当前使用的智能体显示名称。
mcp_servers object[] | MCP 服务列表
agent.mcp_servers
会话当前使用的 MCP 服务配置列表。
name string | MCP 服务名称
agent.mcp_servers.name
MCP 服务名称,供 tools[].mcp_server_name 引用。
type string | MCP 接入方式
agent.mcp_servers.type
MCP 服务接入方式,固定为 url。
url string | MCP 服务地址
agent.mcp_servers.url
会话创建时冻结的 MCP 服务访问地址。
metadata object | 自定义元数据
agent.metadata
创建智能体时设置的自定义键值对,服务端不定义固定子字段。
model object | 模型配置
agent.model
会话当前使用的模型配置。
id string | 模型或接入点 ID
agent.model.id
会话当前使用的模型 ID 或推理接入点 ID。
reasoning_effort string | 推理投入档位
agent.model.reasoning_effort
会话当前使用的推理投入档位。
service_tier string | 推理服务档位
agent.model.service_tier
会话当前使用的推理服务档位。
speed string | 推理速度
agent.model.speed
模型推理速度档位。
thinking string | 思考模式
agent.model.thinking
会话当前使用的思考模式。
multiagent object | 多智能体配置
agent.multiagent
会话当前使用的多智能体配置。
type string | 协作模式
agent.multiagent.type
多智能体协作模式。multiagent_20261001 使用 subagents;coordinator 使用 agents。
agents object[] | 成员智能体
agent.multiagent.agents
当 type 为 coordinator 时,返回会话创建时冻结的成员智能体列表。
type string | 引用类型
agent.multiagent.agents.type
成员引用类型:
agent:引用创建 Session 时冻结的其他智能体配置。self:使用当前智能体在创建会话时的有效配置。
context_management object[] | 上下文管理
agent.multiagent.agents.context_management
创建会话时冻结的成员智能体上下文管理策略。Session 响应会在成员快照未保存自定义策略或已保存策略未包含 compact_threshold 时,展示平台当前默认压缩策略或默认阈值;当前默认阈值为 192000 token。
响应中的默认展示值不会写回 Session 快照。显式保存的 compact_threshold 优先返回。
type string | 策略类型
agent.multiagent.agents.context_management.type
策略类型,固定为 compaction。
compact_threshold integer | 压缩阈值
agent.multiagent.agents.context_management.compact_threshold
查询响应展示的自动压缩触发阈值,单位为 token。未显式保存时,对外接口响应会填充平台当前默认值,当前默认值为 192000;该展示值不会写回 Agent 版本或 Session 快照。
instructions string | 摘要指令
agent.multiagent.agents.context_management.instructions
用户配置的压缩摘要指令。
description string | 智能体说明
agent.multiagent.agents.description
会话创建时冻结的成员智能体说明。
display_name string | 显示名称
agent.multiagent.agents.display_name
会话创建时冻结的成员智能体显示名称。
id string | 智能体 ID
agent.multiagent.agents.id
成员智能体的 ID;当 type 为 self 时,返回当前智能体的 ID。
mcp_servers object[] | MCP 服务列表
agent.multiagent.agents.mcp_servers
会话创建时冻结的成员智能体 MCP 服务配置列表。
name string | MCP 服务名称
agent.multiagent.agents.mcp_servers.name
MCP 服务名称,供 tools[].mcp_server_name 引用。
type string | MCP 接入方式
agent.multiagent.agents.mcp_servers.type
MCP 服务接入方式,固定为 url。
url string | MCP 服务地址
agent.multiagent.agents.mcp_servers.url
会话创建时冻结的 MCP 服务访问地址。
model object | 模型配置
agent.multiagent.agents.model
会话创建时冻结的成员智能体模型配置。
id string | 模型或接入点 ID
agent.multiagent.agents.model.id
成员智能体使用的模型 ID 或推理接入点 ID。
reasoning_effort string | 推理投入档位
agent.multiagent.agents.model.reasoning_effort
成员智能体当前使用的推理投入档位。
service_tier string | 推理服务档位
agent.multiagent.agents.model.service_tier
成员智能体当前使用的推理服务档位。
speed string | 推理速度
agent.multiagent.agents.model.speed
成员智能体使用的模型推理速度档位。
thinking string | 思考模式
agent.multiagent.agents.model.thinking
成员智能体当前使用的思考模式。
name string | 智能体名称
agent.multiagent.agents.name
会话创建时冻结的成员智能体名称。
skills object[] | Skill 列表
agent.multiagent.agents.skills
会话创建时冻结的成员智能体 Skill 配置列表。
type string | Skill 类型
agent.multiagent.agents.skills.type
Skill 来源类型:
ark:方舟平台预置 Skill。skill_hub:Skill Hub 中的公共 Skill。custom:当前账号创建的自定义 Skill。
display_name string | Skill 名称
agent.multiagent.agents.skills.display_name
会话创建时记录的 Skill 展示名称。
skill_id string | Skill ID
agent.multiagent.agents.skills.skill_id
会话使用的 Skill ID。
use_latest boolean | 使用最新版本
agent.multiagent.agents.skills.use_latest
是否在创建会话时选择该 Skill 的最新版本。true 表示选择当时的最新版本,false 表示使用 version 指定的版本。
version string | Skill 版本
agent.multiagent.agents.skills.version
会话创建时冻结的 Skill 版本号。
system string | 系统提示词
agent.multiagent.agents.system
会话创建时冻结的成员智能体系统提示词。
tools object[] | 工具列表
agent.multiagent.agents.tools
会话创建时冻结的成员智能体工具配置列表。
type string | 工具类型
agent.multiagent.agents.tools.type
工具类型:
agent_toolset_20260916:当前版本的方舟内置工具集。agent_toolset_multimodal_20260825:使用image_generate、video_generate、visual_search、general_search、compose_video和todo_write工具。mcp_toolset:指定 MCP 服务提供的工具集。custom:由客户端执行的自定义工具。
可选值:agent_toolset_20260916、agent_toolset_20260701、agent_toolset_multimodal_20260825、mcp_toolset、custom。
configs object[] | 工具配置
agent.multiagent.agents.tools.configs
会话创建时冻结的逐项工具配置。
name string | 工具名称
agent.multiagent.agents.tools.configs.name
会话快照中记录的工具名称。
enabled boolean | 是否启用
agent.multiagent.agents.tools.configs.enabled
工具是否启用。
models object[] | 工具模型列表
agent.multiagent.agents.tools.configs.models
会话快照中记录的图片生成或视频生成工具模型 ID 或推理接入点 ID 列表。
id string | 模型或接入点 ID
agent.multiagent.agents.tools.configs.models.id
该工具绑定的模型 ID 或推理接入点 ID。
default boolean | 是否为默认模型
agent.multiagent.agents.tools.configs.models.default
是否为该工具的默认模型。
name string | 模型名称
agent.multiagent.agents.tools.configs.models.name
模型 ID 或推理接入点 ID 对应的模型名称。
version string | 模型版本
agent.multiagent.agents.tools.configs.models.version
模型 ID 或推理接入点 ID 对应的模型版本。
permission_policy object | 权限策略
agent.multiagent.agents.tools.configs.permission_policy
工具使用的调用许可策略。
type string | 策略类型
agent.multiagent.agents.tools.configs.permission_policy.type
策略类型,always_allow 表示允许直接调用,always_ask 表示每次调用前需要用户确认。
default_config object | 默认工具配置
agent.multiagent.agents.tools.default_config
未在 configs 中单独列出的工具所使用的默认配置。
enabled boolean | 是否启用
agent.multiagent.agents.tools.default_config.enabled
未单独配置的工具是否默认启用。
permission_policy object | 权限策略
agent.multiagent.agents.tools.default_config.permission_policy
未单独配置的工具使用的调用许可策略。
type string | 策略类型
agent.multiagent.agents.tools.default_config.permission_policy.type
策略类型,always_allow 表示允许直接调用,always_ask 表示每次调用前需要用户确认。
description string | 自定义工具说明
agent.multiagent.agents.tools.description
会话创建时冻结的自定义工具说明,用于记录工具的功能和适用场景。
input_schema object | 输入参数定义
agent.multiagent.agents.tools.input_schema
返回 Session 的 Agent 快照中记录的自定义工具输入参数 JSON Schema。
properties object | 参数属性定义
agent.multiagent.agents.tools.input_schema.properties
返回 Session 的 Agent 快照中记录的 JSON Schema 属性映射。每个键为参数名,每个值为对应参数的 JSON Schema 子对象。
required string[] | 必填参数名称列表
agent.multiagent.agents.tools.input_schema.required
返回调用自定义工具时必须提供的参数名称列表。
type string | Schema 类型
agent.multiagent.agents.tools.input_schema.type
返回 JSON Schema 的顶层类型,固定为 object。
mcp_server_name string | MCP 服务名称
agent.multiagent.agents.tools.mcp_server_name
会话中 mcp_toolset 引用的 MCP 服务名称。
name string | 自定义工具名称
agent.multiagent.agents.tools.name
会话创建时冻结的自定义工具名称。
version integer | 版本号
agent.multiagent.agents.version
会话创建时冻结的成员智能体版本号。
subagents object | Subagent 配置
agent.multiagent.subagents
当 type 为 multiagent_20261001 时,返回会话创建时冻结的 Subagent 配置。
type string | Subagent 开关
agent.multiagent.subagents.type
是否允许当前 Agent 创建 Subagent。可选值:enabled、disabled。
inline_agents object | Inline Agent 配置
agent.multiagent.subagents.inline_agents
运行时 Inline Agent 配置。
type string | Inline Agent 开关
agent.multiagent.subagents.inline_agents.type
是否允许在运行时按名称和系统指令创建 Inline Agent。可选值:enabled、disabled。
predefined_agents object[] | 预定义成员
agent.multiagent.subagents.predefined_agents
会话创建时为 multiagent_20261001 冻结的预定义 Agent 和 Self 列表。
- 被引用 Agent 使用
multiagent_20261001时,可以在 Session 深度限制内继续冻结其下级成员。 - 被引用 Agent 使用
coordinator时,按叶子成员处理。
type string | 引用类型
agent.multiagent.subagents.predefined_agents.type
成员引用类型:
agent:引用创建 Session 时冻结的其他智能体配置。self:使用当前智能体在创建会话时的有效配置。
context_management object[] | 上下文管理
agent.multiagent.subagents.predefined_agents.context_management
创建会话时冻结的成员智能体上下文管理策略。Session 响应会在成员快照未保存自定义策略或已保存策略未包含 compact_threshold 时,展示平台当前默认压缩策略或默认阈值;当前默认阈值为 192000 token。
响应中的默认展示值不会写回 Session 快照。显式保存的 compact_threshold 优先返回。
type string | 策略类型
agent.multiagent.subagents.predefined_agents.context_management.type
策略类型,固定为 compaction。
compact_threshold integer | 压缩阈值
agent.multiagent.subagents.predefined_agents.context_management.compact_threshold
查询响应展示的自动压缩触发阈值,单位为 token。未显式保存时,对外接口响应会填充平台当前默认值,当前默认值为 192000;该展示值不会写回 Agent 版本或 Session 快照。
instructions string | 摘要指令
agent.multiagent.subagents.predefined_agents.context_management.instructions
用户配置的压缩摘要指令。
description string | 智能体说明
agent.multiagent.subagents.predefined_agents.description
会话创建时冻结的成员智能体说明。
display_name string | 显示名称
agent.multiagent.subagents.predefined_agents.display_name
会话创建时冻结的成员智能体显示名称。
id string | 智能体 ID
agent.multiagent.subagents.predefined_agents.id
成员智能体的 ID;当 type 为 self 时,返回当前智能体的 ID。
mcp_servers object[] | MCP 服务列表
agent.multiagent.subagents.predefined_agents.mcp_servers
会话创建时冻结的成员智能体 MCP 服务配置列表。
name string | MCP 服务名称
agent.multiagent.subagents.predefined_agents.mcp_servers.name
MCP 服务名称,供 tools[].mcp_server_name 引用。
type string | MCP 接入方式
agent.multiagent.subagents.predefined_agents.mcp_servers.type
MCP 服务接入方式,固定为 url。
url string | MCP 服务地址
agent.multiagent.subagents.predefined_agents.mcp_servers.url
会话创建时冻结的 MCP 服务访问地址。
model object | 模型配置
agent.multiagent.subagents.predefined_agents.model
会话创建时冻结的成员智能体模型配置。
id string | 模型或接入点 ID
agent.multiagent.subagents.predefined_agents.model.id
成员智能体使用的模型 ID 或推理接入点 ID。
reasoning_effort string | 推理投入档位
agent.multiagent.subagents.predefined_agents.model.reasoning_effort
成员智能体当前使用的推理投入档位。
service_tier string | 推理服务档位
agent.multiagent.subagents.predefined_agents.model.service_tier
成员智能体当前使用的推理服务档位。
speed string | 推理速度
agent.multiagent.subagents.predefined_agents.model.speed
成员智能体使用的模型推理速度档位。
thinking string | 思考模式
agent.multiagent.subagents.predefined_agents.model.thinking
成员智能体当前使用的思考模式。
name string | 智能体名称
agent.multiagent.subagents.predefined_agents.name
会话创建时冻结的成员智能体名称。
skills object[] | Skill 列表
agent.multiagent.subagents.predefined_agents.skills
会话创建时冻结的成员智能体 Skill 配置列表。
type string | Skill 类型
agent.multiagent.subagents.predefined_agents.skills.type
Skill 来源类型:
ark:方舟平台预置 Skill。skill_hub:Skill Hub 中的公共 Skill。custom:当前账号创建的自定义 Skill。
display_name string | Skill 名称
agent.multiagent.subagents.predefined_agents.skills.display_name
会话创建时记录的 Skill 展示名称。
skill_id string | Skill ID
agent.multiagent.subagents.predefined_agents.skills.skill_id
会话使用的 Skill ID。
use_latest boolean | 使用最新版本
agent.multiagent.subagents.predefined_agents.skills.use_latest
是否在创建会话时选择该 Skill 的最新版本。true 表示选择当时的最新版本,false 表示使用 version 指定的版本。
version string | Skill 版本
agent.multiagent.subagents.predefined_agents.skills.version
会话创建时冻结的 Skill 版本号。
system string | 系统提示词
agent.multiagent.subagents.predefined_agents.system
会话创建时冻结的成员智能体系统提示词。
tools object[] | 工具列表
agent.multiagent.subagents.predefined_agents.tools
会话创建时冻结的成员智能体工具配置列表。
type string | 工具类型
agent.multiagent.subagents.predefined_agents.tools.type
工具类型:
agent_toolset_20260916:当前版本的方舟内置工具集。agent_toolset_multimodal_20260825:使用image_generate、video_generate、visual_search、general_search、compose_video和todo_write工具。mcp_toolset:指定 MCP 服务提供的工具集。custom:由客户端执行的自定义工具。
可选值:agent_toolset_20260916、agent_toolset_20260701、agent_toolset_multimodal_20260825、mcp_toolset、custom。
configs object[] | 工具配置
agent.multiagent.subagents.predefined_agents.tools.configs
会话创建时冻结的逐项工具配置。
name string | 工具名称
agent.multiagent.subagents.predefined_agents.tools.configs.name
会话快照中记录的工具名称。
enabled boolean | 是否启用
agent.multiagent.subagents.predefined_agents.tools.configs.enabled
工具是否启用。
models object[] | 工具模型列表
agent.multiagent.subagents.predefined_agents.tools.configs.models
会话快照中记录的图片生成或视频生成工具模型 ID 或推理接入点 ID 列表。
id string | 模型或接入点 ID
agent.multiagent.subagents.predefined_agents.tools.configs.models.id
该工具绑定的模型 ID 或推理接入点 ID。
default boolean | 是否为默认模型
agent.multiagent.subagents.predefined_agents.tools.configs.models.default
是否为该工具的默认模型。
name string | 模型名称
agent.multiagent.subagents.predefined_agents.tools.configs.models.name
模型 ID 或推理接入点 ID 对应的模型名称。
version string | 模型版本
agent.multiagent.subagents.predefined_agents.tools.configs.models.version
模型 ID 或推理接入点 ID 对应的模型版本。
permission_policy object | 权限策略
agent.multiagent.subagents.predefined_agents.tools.configs.permission_policy
工具使用的调用许可策略。
type string | 策略类型
agent.multiagent.subagents.predefined_agents.tools.configs.permission_policy.type
策略类型,always_allow 表示允许直接调用,always_ask 表示每次调用前需要用户确认。
default_config object | 默认工具配置
agent.multiagent.subagents.predefined_agents.tools.default_config
未在 configs 中单独列出的工具所使用的默认配置。
enabled boolean | 是否启用
agent.multiagent.subagents.predefined_agents.tools.default_config.enabled
未单独配置的工具是否默认启用。
permission_policy object | 权限策略
agent.multiagent.subagents.predefined_agents.tools.default_config.permission_policy
未单独配置的工具使用的调用许可策略。
type string | 策略类型
agent.multiagent.subagents.predefined_agents.tools.default_config.permission_policy.type
策略类型,always_allow 表示允许直接调用,always_ask 表示每次调用前需要用户确认。
description string | 自定义工具说明
agent.multiagent.subagents.predefined_agents.tools.description
会话创建时冻结的自定义工具说明,用于记录工具的功能和适用场景。
input_schema object | 输入参数定义
agent.multiagent.subagents.predefined_agents.tools.input_schema
返回 Session 的 Agent 快照中记录的自定义工具输入参数 JSON Schema。
properties object | 参数属性定义
agent.multiagent.subagents.predefined_agents.tools.input_schema.properties
返回 Session 的 Agent 快照中记录的 JSON Schema 属性映射。每个键为参数名,每个值为对应参数的 JSON Schema 子对象。
required string[] | 必填参数名称列表
agent.multiagent.subagents.predefined_agents.tools.input_schema.required
返回调用自定义工具时必须提供的参数名称列表。
type string | Schema 类型
agent.multiagent.subagents.predefined_agents.tools.input_schema.type
返回 JSON Schema 的顶层类型,固定为 object。
mcp_server_name string | MCP 服务名称
agent.multiagent.subagents.predefined_agents.tools.mcp_server_name
会话中 mcp_toolset 引用的 MCP 服务名称。
name string | 自定义工具名称
agent.multiagent.subagents.predefined_agents.tools.name
会话创建时冻结的自定义工具名称。
version integer | 版本号
agent.multiagent.subagents.predefined_agents.version
会话创建时冻结的成员智能体版本号。
scene string | 场景标记
agent.scene
会话智能体快照所属的业务场景。
default:默认场景。dreams:用于记忆整理任务的场景。
skills object[] | Skill 列表
agent.skills
会话当前使用的 Skill 配置列表。
type string | Skill 类型
agent.skills.type
Skill 来源类型:
ark:方舟平台预置 Skill。skill_hub:Skill Hub 中的公共 Skill。custom:当前账号创建的自定义 Skill。
display_name string | Skill 名称
agent.skills.display_name
会话创建时记录的 Skill 展示名称。
skill_id string | Skill ID
agent.skills.skill_id
会话使用的 Skill ID。
use_latest boolean | 使用最新版本
agent.skills.use_latest
是否在创建会话时选择该 Skill 的最新版本。true 表示选择当时的最新版本,false 表示使用 version 指定的版本。
version string | Skill 版本
agent.skills.version
会话创建时冻结的 Skill 版本号。
system string | 系统提示词
agent.system
会话当前使用的系统提示词。
tools object[] | 工具列表
agent.tools
会话当前使用的工具配置列表。
type string | 工具类型
agent.tools.type
工具类型:
agent_toolset_20260916:当前版本的方舟内置工具集。agent_toolset_multimodal_20260825:使用image_generate、video_generate、visual_search、general_search、compose_video和todo_write工具。mcp_toolset:指定 MCP 服务提供的工具集。custom:由客户端执行的自定义工具。
可选值:agent_toolset_20260916、agent_toolset_20260701、agent_toolset_multimodal_20260825、mcp_toolset、custom。
configs object[] | 工具配置
agent.tools.configs
会话创建时冻结的逐项工具配置。
name string | 工具名称
agent.tools.configs.name
会话快照中记录的工具名称。
enabled boolean | 是否启用
agent.tools.configs.enabled
工具是否启用。
models object[] | 工具模型列表
agent.tools.configs.models
会话快照中记录的图片生成或视频生成工具模型 ID 或推理接入点 ID 列表。
id string | 模型或接入点 ID
agent.tools.configs.models.id
该工具绑定的模型 ID 或推理接入点 ID。
default boolean | 是否为默认模型
agent.tools.configs.models.default
是否为该工具的默认模型。
name string | 模型名称
agent.tools.configs.models.name
模型 ID 或推理接入点 ID 对应的模型名称。
version string | 模型版本
agent.tools.configs.models.version
模型 ID 或推理接入点 ID 对应的模型版本。
permission_policy object | 权限策略
agent.tools.configs.permission_policy
工具使用的调用许可策略。
type string | 策略类型
agent.tools.configs.permission_policy.type
策略类型,always_allow 表示允许直接调用,always_ask 表示每次调用前需要用户确认。
default_config object | 默认工具配置
agent.tools.default_config
未在 configs 中单独列出的工具所使用的默认配置。
enabled boolean | 是否启用
agent.tools.default_config.enabled
未单独配置的工具是否默认启用。
permission_policy object | 权限策略
agent.tools.default_config.permission_policy
未单独配置的工具使用的调用许可策略。
type string | 策略类型
agent.tools.default_config.permission_policy.type
策略类型,always_allow 表示允许直接调用,always_ask 表示每次调用前需要用户确认。
description string | 自定义工具说明
agent.tools.description
会话创建时冻结的自定义工具说明,用于记录工具的功能和适用场景。
input_schema object | 输入参数定义
agent.tools.input_schema
返回 Session 的 Agent 快照中记录的自定义工具输入参数 JSON Schema。
properties object | 参数属性定义
agent.tools.input_schema.properties
返回 Session 的 Agent 快照中记录的 JSON Schema 属性映射。每个键为参数名,每个值为对应参数的 JSON Schema 子对象。
required string[] | 必填参数名称列表
agent.tools.input_schema.required
返回调用自定义工具时必须提供的参数名称列表。
type string | Schema 类型
agent.tools.input_schema.type
返回 JSON Schema 的顶层类型,固定为 object。
mcp_server_name string | MCP 服务名称
agent.tools.mcp_server_name
会话中 mcp_toolset 引用的 MCP 服务名称。
name string | 自定义工具名称
agent.tools.name
会话创建时冻结的自定义工具名称。
created_at string | 创建时间
会话创建完成的时间,采用 RFC 3339 格式。
environment_id string | 环境 ID
会话创建时绑定的环境 ID。
id string | 会话 ID
会话唯一标识符,格式为 sesn-xxxxx。
stats object | 时长统计
会话的时长统计,包括累计运行时长和从创建到当前或终止时的总时长。
active_seconds number | 累计运行时长
stats.active_seconds
会话实际处于运行状态的累计秒数,与 usage.active_seconds 相同。每次会话从 running 回到 idle 或 terminated,系统才把这次运行的时长累加进去;会话当前还在运行的时间暂不计入。
duration_seconds number | 会话总时长
stats.duration_seconds
会话从创建到当前查询时刻的总时长,单位为秒。会话终止后,该值固定为从创建到终止的时长。
status string | 会话状态
会话运行状态。可选值:idle、running、terminated、rescheduling、initializing、failed、upgrading。
type string | 对象类型
对象类型,固定为session
updated_at string | 更新时间
会话信息最后更新的时间,采用 RFC 3339 格式。
archived_at string | 归档时间
会话首次归档的时间,采用 RFC 3339 格式的 UTC 时间。调用归档接口时,服务端会将 idle 会话转为 terminated。
deployment_id string | 部署 ID
创建该会话的 Deployment ID。仅由 Deployment 创建的会话返回;其他方式创建的会话不返回该字段。
environment object | 环境信息
会话实际使用的环境配置。后续修改原环境不会自动改变该会话。
created_at string | 创建时间
environment.created_at
环境创建完成的时间,采用 RFC 3339 格式。
id string | 环境 ID
environment.id
环境唯一标识符
name string | 环境名称
environment.name
环境名称,用于在环境列表和会话配置中区分该环境。
type string | 对象类型
environment.type
会话环境快照类型。environment 表示直接使用基础 Environment;environment_with_overrides 表示当前会话使用了环境配置覆写。
updated_at string | 更新时间
environment.updated_at
环境配置最后更新的时间,采用 RFC 3339 格式。
config object | 环境配置
environment.config
环境运行配置,包含运行类型、网络策略、依赖包与环境变量
type string | 环境类型
environment.config.type
会话运行环境类型:cloud 表示平台托管环境,self_hosted 表示用户自托管环境。
build_script string | 构建脚本
environment.config.build_script
在依赖包安装后执行的构建脚本;为空表示未配置构建脚本。
env object | 环境变量
environment.config.env
会话运行环境中的环境变量键值对
networking object | 出网策略
environment.config.networking
容器出网策略配置
type string | 出网策略类型
environment.config.networking.type
会话当前使用的出网策略。可选值:unrestricted、limited。
allow_package_managers boolean | 允许包管理器
environment.config.networking.allow_package_managers
限定出网模式下,是否允许访问包管理器软件源。
allowed_hosts string[] | 允许的主机
environment.config.networking.allowed_hosts
限定出网模式下,允许沙箱直接访问的外部域名列表。
packages object | 依赖包配置
environment.config.packages
启动时预装的依赖包配置
apt string[] | apt 包
environment.config.packages.apt
会话环境启动时通过 apt 预装的系统包列表。
cargo string[] | Cargo 包
environment.config.packages.cargo
会话环境启动时通过 Cargo 预装的 Rust crate 列表。
gem string[] | gem 包
environment.config.packages.gem
会话环境启动时通过 RubyGems 预装的 Ruby 包列表。
go string[] | Go 模块
environment.config.packages.go
会话环境启动时通过 Go 工具链预装的模块依赖列表。
npm string[] | npm 包
environment.config.packages.npm
会话环境启动时通过 npm 预装的 Node.js 包列表。
pip string[] | pip 包
environment.config.packages.pip
会话环境启动时通过 pip 预装的 Python 包列表。
type string | 配置类型
environment.config.packages.type
依赖包配置的类型标识,固定为 packages。
setup_script string | 启动脚本
environment.config.setup_script
会话运行环境启动时执行的初始化脚本;留空或未设置表示不执行脚本
spec string 默认值 1x | 运行规格
environment.config.spec
会话使用的运行规格,控制沙箱的 CPU 与内存配置。可选值:1x、2x、4x、8x。
template_id string | 模板 ID
environment.config.template_id
会话环境当前使用的逻辑模板 ID。base 表示常规执行模板,browser 表示浏览器任务模板。
tos object | 产物存储配置
environment.config.tos
智能体产物持久化存储配置。为空表示未配置用户 Bucket,产物落到方舟公共 TOS
bucket string | TOS 桶
environment.config.tos.bucket
会话环境快照中保存的用户 TOS 存储桶名称。
prefix string | 对象前缀
environment.config.tos.prefix
会话环境快照中保存的对象存储目录前缀。
description string | 环境描述
environment.description
环境描述,用于说明环境的用途、网络策略、依赖包等配置
metadata object | 自定义元数据
environment.metadata
用户自定义元数据
overridden_fields string[] | 覆写字段
environment.overridden_fields
当前会话相对基础 Environment 实际覆写的 config 子字段名称列表。仅在 type 为 environment_with_overrides 且存在覆写字段时返回。
scene string | 场景标记
environment.scene
环境快照所属的业务场景。
default:默认场景。dreams:用于记忆整理任务的场景。
resources object[] | 资源列表
当前挂载的资源数组。资源 type 可为 file、memory_store 或 tos。
文件资源 object
通过 Files API 上传并挂载到会话的文件。
created_at string | 挂载时间
resources.created_at
资源挂载到会话的时间,采用 RFC 3339 格式。
id string | 资源 ID
resources.id
会话资源 ID。
type string | 资源类型
resources.type
资源类型,固定为 file。
updated_at string | 更新时间
resources.updated_at
会话资源信息最后更新的时间,采用 RFC 3339 格式。
access string | 访问权限
resources.access
文件访问权限,固定为 read_only。
file_id string | 文件 ID
resources.file_id
当前可用的文件 ID。
mount_path string | 挂载路径
resources.mount_path
文件在会话运行环境中的完整挂载路径。
记忆库资源 object
挂载到会话的记忆库。
created_at string | 挂载时间
resources.created_at
资源挂载到会话的时间,采用 RFC 3339 格式。
id string | 资源 ID
resources.id
会话资源 ID。
type string | 资源类型
resources.type
资源类型,固定为 memory_store。
updated_at string | 更新时间
resources.updated_at
会话资源信息最后更新的时间,采用 RFC 3339 格式。
access string | 访问权限
resources.access
会话对记忆库的访问权限。
-
read_only:智能体只能读取记忆库。 -
read_write:智能体可以读取和修改记忆库。
instructions string | 使用指导
resources.instructions
会话当前用于该记忆库的使用指导。
memory_store_id string | 记忆库 ID
resources.memory_store_id
挂载到会话的记忆库 ID。
TOS 资源 object
挂载到会话的 TOS 对象目录。
created_at string | 挂载时间
resources.created_at
资源挂载到会话的时间,采用 RFC 3339 格式。
id string | 资源 ID
resources.id
会话资源 ID。
type string | 资源类型
resources.type
资源类型,固定为 tos。
updated_at string | 更新时间
resources.updated_at
会话资源信息最后更新的时间,采用 RFC 3339 格式。
access string | 访问权限
resources.access
会话对 TOS 目录的访问权限。可选值:read_only、read_write。
mount_path string | 挂载路径
resources.mount_path
TOS 目录在会话运行环境中的挂载路径。创建会话时未指定挂载路径,则不返回该字段。
tos_bucket string | TOS 存储桶
resources.tos_bucket
TOS 挂载源所在的存储桶名称。
tos_key string | TOS 目录前缀
resources.tos_key
TOS 中已挂载目录的对象前缀。
tos_region string | TOS 地域
resources.tos_region
TOS 挂载源所在地域的 Region ID。
scene string | 会话场景
会话场景标记。
default:普通会话。dreams:用于 Dream 记忆整理任务的会话。
tags object[] | 标签列表
会话标签数组,每项包含 key 和可选的 value。
key string | 标签键
tags.key
标签的键,用于标识分类维度。
value string | 标签值
tags.value
用于记录该标签分类的具体内容。
title string | 会话标题
会话标题,用于快速识别和检索
usage object | 用量统计
会话运行期间累计的运行时长、模型 token 和服务端搜索请求统计。用量统计暂不可用时,服务端不返回该字段。
active_seconds number | 累计运行时长
usage.active_seconds
会话实际处于运行状态的累计秒数。每次会话从 running 回到 idle 或 terminated,系统才把这次运行的时长累加进去;会话当前还在运行的时间暂不计入。
cache_read_input_tokens integer | 缓存读取 token 数
usage.cache_read_input_tokens
会话累计从提示词缓存读取的输入 token 数,已包含在 input_tokens 内。
input_tokens integer | 输入 token 数
usage.input_tokens
会话内所有模型请求累计消耗的输入 token 总数,包含缓存读取和缓存写入的部分。
output_tokens integer | 输出 token 数
usage.output_tokens
会话内所有模型请求累计生成的输出 token 总数。
server_tool_use object | 服务端工具用量
usage.server_tool_use
会话内服务端托管搜索工具累计发起的请求次数。
general_search_requests integer | 通用搜索请求次数
usage.server_tool_use.general_search_requests
服务端执行通用搜索的累计请求次数。
visual_search_requests integer | 视觉搜索请求次数
usage.server_tool_use.visual_search_requests
服务端执行视觉搜索的累计请求次数。
web_fetch_requests integer | 网页抓取请求次数
usage.server_tool_use.web_fetch_requests
服务端执行网页抓取的累计请求次数。
web_search_requests integer | 联网搜索请求次数
usage.server_tool_use.web_search_requests
服务端执行联网搜索的累计请求次数。
cache_creation object | 缓存创建统计
usage.cache_creation
会话累计写入提示词缓存的输入 token 统计。累计值为 0 时,服务端不返回该字段;非 0 时通过 ephemeral_5m_input_tokens 返回。
ephemeral_1h_input_tokens integer | 1 小时缓存输入 token 数
usage.cache_creation.ephemeral_1h_input_tokens
1 小时有效期缓存写入的输入 token 数。当前服务端不返回该字段。
ephemeral_5m_input_tokens integer | 5 分钟缓存输入 token 数
usage.cache_creation.ephemeral_5m_input_tokens
会话累计写入提示词缓存的输入 token 总数,已包含在 input_tokens 内。累计值非 0 时通过该字段返回;累计值为 0 时不返回。
vault_ids string[] / null | 保管库 ID 列表
会话可访问的保管库 ID 列表。智能体可在运行过程中使用其中的凭证。