触发预览部署

为特定分支创建或更新预览部署，以便在合并到生产环境之前审阅文档更改。

POST /project/preview/{projectId}

触发预览部署

cURL

curl --request POST \
  --url https://api.mintlify.com/v1/project/preview/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branch": "<string>"
}
'

202

{
  "statusId": "<string>",
  "previewUrl": "<string>"
}

预览部署适用于 Pro 和 Enterprise 方案。

使用此端点以编程方式为 Git 分支创建或更新预览部署。如果指定分支已存在预览，该端点将触发重新部署，而不会创建重复项。

响应中包含一个 statusId，你可以将其传递给 Get deployment status 以跟踪部署进度。

​

用例

• CI/CD 流水线：在拉取请求被打开或更新时自动创建预览部署。
• 定时预览：按计划为长期运行的功能分支生成预览。
• 自定义工具：将预览创建集成到内部工作流或 Slack 机器人中。

​

速率限制

此端点允许每个组织每分钟最多 5 个请求。

授权

Authorization · string · header · 必填

Authorization 请求头需要使用 Bearer token。请使用以 mint_ 为前缀的管理员 API key。该 key 是仅供服务端使用的机密密钥。你可以在控制台的 API keys 页面 中生成一个。

路径参数

projectId · string · 必填

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

请求体

application/json

branch · string · 必填

要为其创建预览部署的 Git 分支名称。

Minimum string length: 1

响应

202

application/json

预览部署已成功加入队列。

statusId · string

用于跟踪预览部署的状态 ID。可将其与 Get deployment status 端点配合使用。

previewUrl · string

预览部署所托管的 URL。