# 触发预览部署 (/zh/api/preview/trigger)

<!-- agent-signals: reading_time_min: 1 · est_tokens: 726 · updated: 2026-09-23 -->
Related: [触发部署](/zh/api/update/trigger.md), [触发自动化](/zh/api/automations/trigger.md)

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

响应中包含一个 `statusId`，你可以将其传递给 [Get deployment status](/zh/api/update/status) 以跟踪部署进度。

<div id="branch-requirements">
  ## 分支要求 [#分支要求]
</div>

`branch` 必须存在于与你的 Mintlify 项目连接的仓库中。不支持 fork 上的分支。Mintlify GitHub 应用必须安装在仓库上才能构建预览，因此无法从 fork 分支构建预览。有关如何预览来自 fork 的更改，请参阅[Fork 拉取请求](/zh/deploy/preview-deployments#fork-pull-requests)。

<div id="use-cases">
  ## 用例 [#用例]
</div>

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

<div id="access-to-previews">
  ## 预览的访问权限 [#预览的访问权限]
</div>

通过此端点创建的预览可公开访问，除非你为预览启用了身份验证，该设置会应用于你部署中的所有预览。你无法通过此端点为单个预览设置密码保护。请参阅[限制预览部署的访问权限](/zh/deploy/preview-deployments#restrict-access-to-preview-deployments)。

<div id="rate-limits">
  ## 速率限制 [#速率限制]
</div>

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

`POST /project/preview/{projectId}`

为特定分支创建或更新预览部署。如果该分支已有预览，则会触发重新部署。返回用于跟踪进度的状态 ID 和预览 URL。

使用管理员 API 密钥进行身份验证。

## OpenAPI

```json
{
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "parameters": [
    {
      "name": "projectId",
      "in": "path",
      "description": "项目 ID。可在控制台的 [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) 页面中复制。",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "branch"
          ],
          "properties": {
            "branch": {
              "type": "string",
              "description": "要为其创建预览部署的 Git 分支名称。",
              "minLength": 1
            }
          }
        }
      }
    }
  },
  "responses": {
    "202": {
      "description": "预览部署已成功加入队列。",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "statusId": {
                "type": "string",
                "description": "用于跟踪预览部署的状态 ID。可将其与 [Get deployment status](/zh/api/update/status) 端点配合使用。"
              },
              "previewUrl": {
                "type": "string",
                "description": "预览部署所托管的 URL。"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "无效请求。`branch` 字段为必填项。",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "403": {
      "description": "你当前的方案不支持预览部署。",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```