跳转到主要内容
POST
触发 Autopilot webhook
使用此端点从你自己的工具启动一次 Autopilot 运行。每个请求都会将一次运行加入队列,该运行按照请求体中的 prompt 执行,并使用与 Autopilot 其他运行相同的上下文、技能和审核设置。 必须为该项目启用 Autopilot。

用例

  • 发布脚本:在你创建标签或发布新版本 SDK 时,告诉 Autopilot 发布了什么。
  • CI/CD 流水线:在部署或合并到 main 之后,让 Autopilot 检查文档。
  • 内部工具:从你已在使用的内部仪表盘、支持工具或定时任务发送文档请求。

获取 webhook URL 和认证请求头

在控制台中打开 Autopilot 页面。Webhook 部分会显示完整的 webhook URL,以及用于 Authorization: Bearer <api-key> 请求头模板的 Copy auth header 操作。 将 <api-key> 替换为一个未过期且具有写入权限的组织 API 密钥。在 API keys 页面创建或管理密钥。

示例

通过 GitHub Action 让 Autopilot 为每次发布编写文档:
.github/workflows/autopilot-release.yml

请求之后会发生什么

Autopilot 会像处理其他运行一样处理该 prompt。当它创建或更新拉取请求时,会像处理代码变更时一样分配审核者并通知你的团队。每次运行都会在 Autopilot 页面上显示为单独的会话线程。 如果 Autopilot 已暂停,该运行会等到你恢复 Autopilot 后再执行。

速率限制和积分

此端点与 触发部署、触发自动化 和 触发自动化 webhook 共享速率限制:每个组织每 10 秒最多 10 次请求。 当一次运行创建或更新拉取请求时,会消耗 250 积分。请参阅 Autopilot 积分。

授权

Authorization
string
header
必填

Authorization 请求头需要使用 Bearer 令牌。请使用管理员 API 密钥。这是仅供服务端使用的机密密钥。你可以在控制台的 API 密钥页面 中生成一个。

路径参数

projectId
string
必填

你的项目 ID。可在控制台的 API keys 页面复制。

请求体

application/json
prompt
string
必填

给 Autopilot 的指令,例如发生了哪些变化以及需要在文档中更新什么。

Maximum string length: 20000

响应

Autopilot 运行已成功加入队列。

success
boolean

运行加入队列时始终为 true。

runId
string

已加入队列的 Autopilot 运行的 ID。