API 与程序化接入
选择 Cloud Agents API、SDK 和企业数据接口,建立认证、运行与结果处理流程。
Cursor 的程序接口覆盖 Agent 工作流、团队管理与统计。Cloud Agents API 和 SDK 运行带上下文、工具、命令与编辑能力的 Agent,不是独立的模型推理或 chat-completions API。
选择接口
| 接口 | 用途与可用范围 |
|---|---|
| Cloud Agents API | 创建和管理云端 Agent;当前 v1 为 public beta,API 总览标记所有套餐可用 |
| TypeScript / Python SDK | 统一接入本地和云端运行时;面向所有用户 |
| SDK Bridge | 用其他语言实现 SDK 的开放协议与独立二进制 |
| Admin / Analytics / AI Code Tracking | Enterprise 团队管理、用量和代码归因 |
| Bugbot API | Enterprise 主动触发评审并读取评审分析 |
| Origin API | 仓库、提交、checks、PR 和 App 安装;early beta |
接口可用性与具体运行能力的账号权限分别判断。不要因为能创建 key 就假定已获得全部 Enterprise 或 Cloud Agents 功能。
Cloud Agents 接入路径
- 认证与限流:选择 key、HTTP 认证和重试方式。
- 创建任务:仓库、模型、执行环境和可选能力。
- Runs 与状态:追加提示、判断完成和读取用量。
- SSE 流:实时输出、断线续接和过期处理。
- 产物与生命周期:下载、归档、恢复和删除。
- 环境 API:保存配置和查询 Build。
- 旧版与 Webhook:v0 兼容边界和通知校验。
自托管池的 claim、session token 和伸缩工作流见Worker Controller。
在应用中使用官方客户端,见Agent SDK。
Bugbot API可触发评审、读取 dry-run findings 和管理配置。
管理与分析接口
- Admin API与组管理。
- 用量对账与Analytics。
- AI Code Tracking:提交和采纳变更。
跨团队管理
- Organization API:成员集合同步与合同用量。
- 组织组 API:g_ 标识和组成员。
- 模型策略 API:custom policy、catalog 参数和批量部分成功。
本节文档
- API 认证与限流使用正确的用户或团队凭据,区分 Basic、Bearer、分页和缓存规则。
- 创建 Cloud Agent通过 v1 创建持久 Agent 与首轮 Run,配置仓库、模型、环境和任务能力。
- Runs、状态与用量区分 Agent 生命周期与单轮执行状态,追加任务并读取结果和 token 统计。
- SSE 事件与断线续接消费单轮流事件,避免重复渲染,并正确处理断开、过期与工具截断。
- 产物、归档与删除获取 Agent 产物的临时下载地址,区分可逆归档和永久删除。
- 环境与 Builds API程序化保存共享或个人环境,读取构建状态和真正用于启动的快照。
- v0 迁移与 Webhook识别旧 API 的数据形状,校验仍由 v0 提供的状态通知。
- Bugbot 评审与管理 API异步触发评审、读取 dry-run findings,并分开使用管理端点的认证。
- 团队 Admin API读取成员与调整限额,区分批量部分成功、移除限制和仓库策略。
- 用量与费用 API按小时采集事件,使用 chargedCents 对账并正确处理时间边界和身份类型。
- 目录组与账单组 API按正确路径和 ID 管理团队组,保留 SCIM 所有权并核对成员变更结果。
- Analytics API读取团队及用户维度指标,控制日期窗口、分页、认证和缓存。
- AI Code Tracking API提取提交与采纳变更统计,处理 Alpha 字段、设备签名和空值。
- Organization API 与跨团队同步选择组织 scope,按完整团队集合同步成员,并区分合同窗口费用。
- Organization Groups API用 g_ 标识管理跨团队群体,处理名称查询、限额与 SCIM 约束。
- 模型策略 API 与批量配置先建立 custom policy,再修改 catalog 模型、参数和跨团队配置。