跳转到主要内容

API 发布说明

本页用于跟踪 Devin 的 API(v1、v2 和 v3)的相关变更。应用功能发布说明请参见 应用发布说明

2025 年

2025 年 12 月

v3 API 更新
  • Notes 和 Playbooks 路由(12 月 1 日):为 v3 API 新增企业级和组织级 Notes 和 Playbooks 管理端点。Notes 端点需要 ManageAccountKnowledge 权限,Playbooks 端点需要 ManageAccountPlaybooks 权限。

2025 年 11 月

v2 Enterprise API 更新
  • 分页 limit 更新(11 月 21 日):每次请求的最大分页 limit 从 1000 降低为 200,以提升性能和可靠性。默认 limit 仍为 100。此变更不影响 v1 External API。
  • Sessions 路由(11 月 16 日):为 v2 API 新增了全面的会话管理端点,供企业管理员使用。
  • Snapshots API 端点(11 月 3 日):新增端点,以便以编程方式获取快照详情。
v1 API 更新
  • 终止会话端点(10 月 31 日):新增端点,以编程方式终止正在运行的会话。

2025 年 10 月

v3 API 发布(测试版)
  • API v3 发布(10 月 23 日):发布 v3 API,提供完整的 RBAC 支持、服务用户认证模型,以及针对服务用户操作的全面审计日志记录。
v2 Enterprise API 更新
  • 快照创建端点(10 月 30 日):新增 V2 Enterprise Organizations API 端点,供企业管理员以编程方式克隆代码仓库,并创建包含自定义安装步骤和启动命令的快照。
  • Playbooks API 改进(10 月 14 日):新增用于发布企业版 playbook 的 API,并改进了以编程方式管理 playbook 的相关功能。

2025 年 9 月

v2 Enterprise API 更新
  • Roles 路由(9 月 25 日):新增 Enterprise 角色路由,提供五个用于以编程方式管理角色的 API 端点。
v1 API 更新
  • Playbooks API(9 月 6 日):在 v1 中新增完整的 Playbooks API 端点集,用于以编程方式创建、更新、列出和删除 playbook。
  • Secrets 端点(9 月 5 日):新增 POST /v1/secrets 端点,用于通过 API 创建 secrets。

2025 年 3 月

v2 Enterprise API 发布
  • API v2 发布(3 月 23 日):面向企业管理员推出 Enterprise API v2,提供组织管理、用量追踪和成员管理等功能。

2024 年

2024 年 10 月

v1 API 发布(10 月 26 日)
  • 推出用于以编程方式创建和管理会话的 REST API
  • 用于会话创建、监控和管理的端点
  • 支持文件附件上传和下载
  • 使用 API keys 进行基本身份验证
  • 支持幂等的会话创建
  • 使用场景:自动化拉取请求(PR)审查、lint 错误修复、迁移

API 版本管理策略

向后兼容性

我们尽力在同一主版本内保持向后兼容性。不向后兼容的变更将会:
  1. 至少提前 7 天进行公告
  2. 记录在本发行说明中
  3. 在适用情况下提供迁移指南

弃用流程

当我们弃用某个 API 功能时:
  1. 公告:我们会发布弃用公告并给出时间表
  2. 弃用期:该功能在被标记为已弃用的情况下仍然可用
  3. 移除:在弃用期结束后,该功能会被移除

版本支持

  • v1:正式可用,持续维护
  • v2:正式可用,持续维护
  • v3:测试版 - 功能可能变更,目前不建议用于生产环境

迁移指南

从 v1 迁移到 v3

如果你正在构建需要细粒度权限控制的新集成,建议使用 v3 而不是 v1: 主要差异:
  • 认证:v3 需要使用服务用户 Token,而不是个人/服务 API key
  • 授权:v3 提供完整的 RBAC(基于角色的访问控制)权限模型
  • 端点(Endpoints):v3 使用不同的 URL 模式(/v3beta1/* 而不是 /v1/*
迁移步骤:
  1. Enterprise Settings > Service Users 中创建一个服务用户
  2. 为该服务用户分配合适的角色
  3. 为该服务用户生成一个 API key
  4. 将你的集成更新为使用 v3 端点
  5. 在非生产环境中进行充分测试
查看 v3 API 文档 →

从 v2 迁移到 v3

与 v2 相比,v3 为企业自动化提供了更高的灵活性: 主要差异:
  • 认证(Authentication):v3 使用服务账号,而不再要求 Enterprise Admin 的个人密钥
  • 授权(Authorization):v3 支持细粒度 RBAC(基于角色的访问控制),而不再仅限企业管理员访问
  • 作用范围(Scope):v3 可以限定到特定组织,而 v2 始终作用于整个企业
何时迁移:
  • 你需要在非管理员权限下进行自动化
  • 你希望将 API 访问范围限定到特定组织
  • 你需要在人类账号与服务账号之间有清晰的隔离
  • 你需要为自动化操作提供详细的审计日志

支持

如果您对 API 变更有疑问或需要迁移方面的协助: