跳转到主要内容
本指南将引导你为 团队和标准组织(非 Enterprise)设置 API 访问权限。你将创建一个服务用户、获取凭证,并在几分钟内完成首次 API 调用。
如果你所在的是具有多个组织、自定义角色或 SSO 的 Enterprise 环境,请参阅 Enterprise 快速开始

步骤 1:创建服务用户

  1. 在你的组织中,进入 Settings > Service users
  2. 点击 Create service user
  3. 选择一个具有描述性的名称(例如:“CI Pipeline”、“Monitoring Bot”)
  4. 选择一个角色:
    • Admin — 对会话、Knowledge、playbooks、secrets 和设置拥有完整管理权限
    • Member — 可以创建和管理 Devin 会话,并查看资源
对于大多数自动化场景,请使用 Member 角色。仅当你的集成需要管理组织设置或其他用户时,才使用 Admin

步骤 2:生成 API key

  1. 创建服务用户后,点击 Generate API key
  2. 请立即复制该 API key —— 它以 cog_ 开头,之后将不再显示
  3. 将其以环境变量的形式安全保存:
export DEVIN_API_KEY="cog_your_key_here"

步骤 3:发起首次 API 调用

创建一个 Devin 会话:
curl -X POST "https://api.devin.ai/v3/organizations/sessions" \
  -H "Authorization: Bearer $DEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "Create a simple Python script that prints Hello World"}'
你无需在 URL 中指定组织 ID。 由于你的服务用户只属于单个组织,API 会自动解析。你也可以选择在其中包含它:/v3/organizations/{org_id}/sessions。你可以在 Settings → Organization details 中找到组织 ID。
想让会话归属到你的用户吗? 默认情况下,会话会归属到服务用户。要代表特定用户创建会话(这样它们会显示在该用户的会话列表中),请在请求体中添加 "create_as_user_id": "user_abc123"。这需要 Admin 角色(其中包含 ImpersonateOrgSessions 权限)。详情参见 Session attribution

第 4 步:常用操作

列出会话

curl "https://api.devin.ai/v3/organizations/sessions" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

向运行中的会话发送消息

export SESSION_ID="your_session_id"

curl -X POST "https://api.devin.ai/v3/organizations/sessions/$SESSION_ID/messages" \
  -H "Authorization: Bearer $DEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "Please also add unit tests"}'

管理 Knowledge

# 列出 Knowledge 条目
curl "https://api.devin.ai/v3/organizations/knowledge/notes" \
  -H "Authorization: Bearer $DEVIN_API_KEY"

# 创建 Knowledge 条目
curl -X POST "https://api.devin.ai/v3/organizations/knowledge/notes" \
  -H "Authorization: Bearer $DEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Coding standards", "trigger_description": "When writing code", "body": "Use TypeScript strict mode..."}'

Teams 用户权限

Teams 组织采用简单的权限模型:
角色是否可以创建会话是否可以管理资源是否可以管理设置
Member是(Knowledge、运行手册、密钥)
Admin
如需基于角色的细粒度访问控制(RBAC),请参阅 Enterprise 快速入门

后续步骤