Skip to main content
Session 是一次实际运行的载体:它把一个 Agent 放进一个 Environment,维护对话历史与沙箱状态,通过事件与你的应用交互。会话是长生命周期、有状态的——可以持续数小时、跨多轮交互,随时恢复。

创建一个会话

最小请求只需要 agentenvironment_id 两个字段:
会话事件加密:创建时加 x-events-encrypted: true,对话和工具 I/O 按客户密钥加密落库。开关创建后不能改。完整说明见 会话事件数据加密
请求字段: 响应是完整的 Session 对象。agent 字段回显解析后的配置快照(钉住的版本 ⊕ 会话级覆盖),status 初始为 idle
响应中的 budget 字段当前恒为 null:平台暂不支持会话级消费上限,用量请通过 usage 字段与账单侧监控。

用初始事件预置会话

创建时通过 initial_events 预置最多 50 条 user.message,适合把既有对话上下文或任务说明一次性带入。会话不会因初始事件立即开始执行——它们只是进入事件历史,Agent 会在你发送第一条常规消息(或订阅事件流触发执行)后带着这些上下文工作:
内容块约束:每条事件非空且至多 20 个内容块,类型为 textimage(初始事件不支持 document);每条至多 3 张图片,每张 ≤5 MB。

为会话覆盖 Agent 配置

agent 的对象形态可以钉住特定版本,或在不改动 Agent 的前提下为单个会话覆盖配置:
覆盖语义:
  • 可覆盖 modelsystemtoolsmcp_serversskills;每个字段都是整体替换(非深合并)。
  • 覆盖只作用于本会话,Agent 本身不变;会话创建后覆盖即冻结。
  • 覆盖含 mcp_toolset 时须与 agent.mcp_servers 一起提供,保证引用一致。
  • 钉不存在的 version 返回 400,并在错误信息中提示当前最新版本。

通过 Vault 提供 MCP 鉴权

如果 Agent 声明了需要鉴权的 MCP 服务器,创建会话时传 vault_ids 引用凭据集合。凭据按服务器 URL 匹配,详见连接 MCP凭据管理

启动会话

会话创建后处于 idle 状态,尚未供给沙箱。先打开事件流,再发消息——SSE 只转发连接建立后的实时事件,发完再订流会错过本轮进展。 典型的启动顺序:
  1. 打开 SSE 事件流:GET /v1/sessions/:id/events/stream(保持连接)。
  2. 发送第一条 user.message 事件:POST /v1/sessions/:id/events
  3. 会话进入 running:平台按环境快照供给沙箱、挂载资源与 Skill、启动 Agent 循环。
  4. Agent 完成本轮工作后回到 idle(事件 session.status_idle),等待你的下一条消息。
发送消息与处理事件的完整说明见事件与流式输出

下一步

管理会话

查询、更新、归档与删除会话

事件与流式输出

事件类型、SSE、打断与引导

文件

向会话挂载输入文件

记忆

跨会话保留长期记忆

本页对应 OpenAPI

Session:创建、列出、更新、事件