跳转到主要内容
本页将介绍使用 Devin API 的常见端到端工作流程。每个流程都包含完整的 API 调用顺序及代码示例。有关各个端点的详细信息,请参阅相关的 API 参考页面。

设置

在运行任何示例之前,请先设置以下环境变量:

快速开始:从 API key 到首次会话

最常见的工作流程——完成身份验证、查看你的账户,并创建你的第一个会话。

步骤 1:验证你的凭据

组织作用域的服务用户可以跳到步骤 3——你已经从 Settings 页面知道了你的 org ID。
响应:

步骤 2:列出你的组织

企业版服务用户可以列出所有组织:
组织作用域的服务用户已经知道其 org ID (显示在 Settings > Devin API 页面顶部,即预配该服务用户的页面) 。

步骤 3:创建会话

响应:

步骤 4:轮询获取事件

通过轮询消息来监控会话:

完整的 Python 示例


下载会话附件

获取会话生成的文件 (日志、截图、生成的代码等) 。

步骤 1:获取会话

步骤 2:列出附件

响应:

步骤 3:下载

请勿使用 API 密钥访问 url 值。该 URL 需要先登录 Web 应用才能访问。 请使用下载端点,并传入 attachment_id 和 name 值。该端点会返回 307 重定向,指向一个短期有效的 URL,因此请求时需启用重定向跟随:

完整的 Python 示例


Knowledge 和 playbook 管理

管理 Devin 在多个会话中使用的上下文和指示。

创建 Knowledge 笔记

列出 Knowledge 笔记

更新 Knowledge 笔记

删除 Knowledge 笔记

创建 playbook

/playbooks 端点已弃用。操作手册正在迁移到技能。在已完成迁移的账户中,此请求会写入该 playbook 对应的技能。对于 2026 年 10 月 24 日及之后创建且没有任何 playbook 的账户,调用这些端点将返回 410。请参阅操作手册正在迁移到技能。

完整的 Python 示例


计划自动化 会话

创建带有 schedule:recurring trigger 的 自动化,即可创建 recurring 会话。该 trigger 接受一个 rrule 条件:一条以 UTC 计算的 iCalendar RRULE (例如 FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR;BYHOUR=13;BYMINUTE=0 表示夏令时期间工作日的美国东部时间上午 9 点) 。需要 ManageOrgAutomations permission。
较早的 /schedules 端点已 deprecated。自 2026 年 9 月 24 日起,对于已迁移到 自动化 的组织,POST /v3/organizations/{org_id}/schedules 将返回 403。请参阅 API 发布说明。

创建计划 自动化

如需一次性运行,请使用带 COUNT=1 的 DTSTART,例如 DTSTART:20260915T170000Z\nRRULE:FREQ=DAILY;COUNT=1。该自动化只会触发一次,随后自动停用。

列出、更新和删除

完整的 Python 示例


从任何地方移交任务

由于 Sessions API 只需一次请求就能创建 cloud Devin 会话,因此任何工具、脚本或代码 Agent 都可以将工作“移交”给 Devin——把当前代码仓库、分支和未提交的更改一并打包到提示中,让云端会话从你离开的地方继续。

创建带有代码仓库上下文的会话

云端会话会克隆代码仓库,应用你提示中的上下文,并在独立的 VM 中运行,提供 shell、浏览器以及对整个代码仓库的完整访问权限。你可以通过轮询消息或在 Devin web app 中跟踪其进度。
git diff HEAD 可能包含未提交的 secrets——API 密钥、令牌或对 .env 的修改——而提示也会上传到云端会话。移交前,请检查你的 diff,并提交、暂存或移除敏感更改。
不想自己实现这套流程?在你的 shell 中将 Devin API 密钥导出为 DEVIN_API_KEY,然后让你的代码 Agent 按照此流程创建 Devin 会话即可。请参阅移交给 Devin。

错误处理

以上所有示例在生产环境中都应包含错误处理。下面提供一种可复用的写法:

支持

需要帮助?

如果您对 API 有任何疑问或需要报告问题,请发送电子邮件至 support@cognition.ai