2025
2025 年 12 月
v3 API 更新
- 会话归档端点(12 月 11 日):新增
POST /v3beta1/organizations/{org_id}/sessions/{devin_id}/archive端点用于归档会话。同时在DELETE /v3beta1/organizations/{org_id}/sessions/{devin_id}(终止会话)中新增archive查询参数,并在会话响应中新增is_archived字段。 - Order 参数移除(12 月 11 日):**不兼容变更:**从会话列表端点(
GET /v3beta1/organizations/{org_id}/sessions)中移除了order查询参数。客户端必须停止发送order;请改用基于游标的分页方式,使用first/after参数。 - 高级会话支持(12 月 8 日):新增对高级会话模式(
analyze、create、improve、batch、manage)的支持,并新增请求参数:advanced_mode、child_playbook_id、session_links和bypass_approval。会话响应现在包含child_session_ids、parent_session_id和is_advanced字段。 - Searches 路由(12 月 10 日):在
GET /v3beta1/enterprise/searches和GET /v3beta1/organizations/{org_id}/searches新增 Enterprise 和组织级别的搜索端点,用于列出搜索记录,并支持分页和过滤。 - 审计日志改进(12 月 10 日):在审计日志响应中新增
data对象、service_user_name和user_email字段。新增update_git_permission动作类型。 - Session Tags 路由(12 月 5 日):在
/v3/beta/enterprise/organizations/{org_id}/tags添加了 CRUD 端点,用于按组织管理允许的会话标签。当启用标签验证时,会话创建和标签更新将强制使用允许列表中的标签。 - Enterprise Sessions 端点(12 月 5 日):新增
GET /v3/beta/enterprise/sessions,用于在整个 Enterprise 范围内列出会话,并支持可选的org_ids过滤。 - Git Permissions 更新(12 月 5 日):新增用于按路径前缀匹配代码仓库的
prefix_path字段。新增PUT和DELETE端点,用于批量替换或清空某个组织的全部权限。 - 会话模拟(Session impersonation,12 月 5 日):在会话创建端点中新增
create_as_user_id参数,允许服务用户以其他用户身份创建会话。 - Hypervisors 响应变更(12 月 5 日):Hypervisors 端点的响应现在返回
utilization_percentage,不再返回max_slots和available_slots。 - Notes 和 Playbooks 路由(12 月 1 日):在 v3 API 中新增 Enterprise 和组织级别的 Notes 与 Playbooks 管理端点。Notes 端点需要
ManageAccountKnowledge权限,Playbooks 端点需要ManageAccountPlaybooks权限。
- Sessions messages 字段(12 月 11 日):在 v2 sessions API 响应中新增
messages字段,提供与 v1 API 类似的全部会话消息。 - 响应 schema 改进(12 月 11 日):为审计日志、快照和 Playbooks 端点新增规范的响应 schema,包括
AuditLogsResponse、EnterpriseSnapshotResponse和EnterprisePlaybookResponse。
- 审计日志弃用(12 月 5 日):
/v1/audit-logs端点已弃用;请改用 v2 或 v3 的审计日志端点。
2025 年 11 月
v2 Enterprise API 更新
- 分页 limit 调整(11 月 21 日):为提升性能和可靠性,将最大分页上限从每次请求 1000 条减少到 200 条。默认上限仍为 100。此变更不影响 v1 External API。
- Sessions 路由(11 月 16 日):在 v2 API 中为 Enterprise 管理员新增了完整的会话管理端点。
- Snapshots API 端点(11 月 3 日):新增用于以编程方式获取快照详情的端点。
- 终止会话端点(10 月 31 日):新增端点,用于以编程方式终止正在运行的会话。
2025 年 10 月
v3 API 发布(Beta)
- API v3 发布(10 月 23 日):发布 v3 API,提供完整的 RBAC 支持、服务用户认证模型,以及针对服务用户操作的全面审计日志记录。
- 快照创建端点(10 月 30 日):新增 v2 Enterprise Organizations API 端点,供 Enterprise 管理员以编程方式克隆代码仓库并创建快照,支持自定义设置步骤和启动命令。
- Playbooks API 改进(10 月 14 日):新增用于发布 Enterprise Playbooks 的 API,并改进了以编程方式管理 Playbooks 的功能。
2025 年 9 月
v2 Enterprise API 更新
- Roles 路由(9 月 25 日):新增 Enterprise roles 路由,提供五个 API 端点,用于以编程方式管理角色。
- Playbooks API(9 月 6 日):在 v1 中新增完整的 Playbooks API 端点,用于以编程方式创建、更新、列出和删除 Playbooks。
- Secrets 端点(9 月 5 日):新增
POST /v1/secrets端点,用于通过 API 创建 secrets。
2025 年 3 月
v2 Enterprise API 发布
- API v2 发布(3 月 23 日):为 Enterprise 管理员发布 Enterprise API v2,支持组织管理、用量跟踪和成员管理功能。
2024 年
2024 年 10 月
v1 API 发布(10 月 26 日)
- 推出用于以编程方式创建和管理会话的 REST API
- 用于会话创建、监控和管理的端点
- 支持文件附件上传和下载
- 使用 API keys 进行基本身份验证
- 支持幂等的会话创建
- 使用场景:自动化拉取请求(PR)审查、lint 错误修复、迁移
API 版本管理策略
向后兼容性
- 至少提前 7 天进行公告
- 记录在本发行说明中
- 在适用情况下提供迁移指南
弃用流程
- 公告:我们会发布弃用公告并给出时间表
- 弃用期:该功能在被标记为已弃用的情况下仍然可用
- 移除:在弃用期结束后,该功能会被移除
版本支持
- v1:正式可用,持续维护
- v2:正式可用,持续维护
- v3:测试版 - 功能可能变更,目前不建议用于生产环境
迁移指南
从 v1 迁移到 v3
- 认证:v3 需要使用服务用户 Token,而不是个人/服务 API key
- 授权:v3 提供完整的 RBAC(基于角色的访问控制)权限模型
- 端点(Endpoints):v3 使用不同的 URL 模式(
/v3beta1/*而不是/v1/*)
- 在 Enterprise Settings > Service Users 中创建一个服务用户
- 为该服务用户分配合适的角色
- 为该服务用户生成一个 API key
- 将你的集成更新为使用 v3 端点
- 在非生产环境中进行充分测试
从 v2 迁移到 v3
- 认证(Authentication):v3 使用服务账号,而不再要求 Enterprise Admin 的个人密钥
- 授权(Authorization):v3 支持细粒度 RBAC(基于角色的访问控制),而不再仅限企业管理员访问
- 作用范围(Scope):v3 可以限定到特定组织,而 v2 始终作用于整个企业
- 你需要在非管理员权限下进行自动化
- 你希望将 API 访问范围限定到特定组织
- 你需要在人类账号与服务账号之间有清晰的隔离
- 你需要为自动化操作提供详细的审计日志
支持
- 电子邮件:[email protected]
- 文档:API 概览
- 身份验证指南:身份验证与 API key
