diff --git a/es.json b/es.json
index 9ad70f573..224dc8883 100644
--- a/es.json
+++ b/es.json
@@ -340,7 +340,8 @@
"icon": "activity",
"pages": [
"es/api/update/trigger",
- "es/api/update/status"
+ "es/api/update/status",
+ "es/api/preview/trigger"
]
},
{
diff --git a/es/api/introduction.mdx b/es/api/introduction.mdx
index e22343dd6..f70f3c017 100644
--- a/es/api/introduction.mdx
+++ b/es/api/introduction.mdx
@@ -12,6 +12,7 @@ La REST (Representational State Transfer) API de Mintlify te permite interactuar
* [Trigger update](/es/api/update/trigger): Activa una actualización de tu sitio cuando quieras.
* [Get update status](/es/api/update/status): Obtén el estado de una actualización y otros detalles de tu documentación.
+* [Trigger preview deployment](/es/api/preview/trigger): Crea o actualiza una implementación de vista previa para una rama específica.
* [Create agent job](/es/api/agent/v2/create-agent-job): Crea una tarea de agente para editar tu documentación automáticamente.
* [Get agent job](/es/api/agent/v2/get-agent-job): Obtén los detalles y el estado de una tarea de agente específica.
* [Send follow-up message](/es/api/agent/v2/send-message): Envía un mensaje de seguimiento a una tarea de agente existente.
@@ -28,6 +29,7 @@ La REST (Representational State Transfer) API de Mintlify te permite interactuar
* **Implementaciones automatizadas**: Activa actualizaciones del sitio a intervalos establecidos o cuando se produzcan eventos con [Trigger update](/es/api/update/trigger) y [Get update status](/es/api/update/status).
* **Integración CI/CD**: Actualiza la documentación como parte de tu pipeline de implementación cuando el código cambie con [Trigger update](/es/api/update/trigger).
+* **Implementaciones de vista previa**: Crea o actualiza implementaciones de vista previa de forma programática en tu pipeline CI/CD con [Trigger preview deployment](/es/api/preview/trigger).
* **Integraciones personalizadas**: Inserta el Asistente de IA en tu producto, portal de soporte o herramientas internas con [Create assistant message](/es/api/assistant/create-assistant-message-v2), [Search documentation](/es/api/assistant/search) y [Get page content](/es/api/assistant/get-page-content).
* **Edición automatizada**: Usa trabajos de agente para actualizar la documentación programáticamente y a escala con [Create agent job](/es/api/agent/v2/create-agent-job), [Get agent job](/es/api/agent/v2/get-agent-job) y [Send follow-up message](/es/api/agent/v2/send-message).
* **Exportación de Analytics**: Exporta comentarios, conversaciones del assistant y datos de visitantes para análisis externo con [Get user feedback](/es/api/analytics/feedback), [Get assistant conversations](/es/api/analytics/assistant-conversations) y [Get assistant caller stats](/es/api/analytics/assistant-caller-stats).
@@ -44,7 +46,7 @@ Puedes crear hasta 10 API keys por hora y por organización.
### Clave de la API de administrador
-Usa la clave de la API de administrador para autenticar solicitudes a [Trigger update](/es/api/update/trigger), [Get update status](/es/api/update/status), [Create agent job](/es/api/agent/v2/create-agent-job), [Get agent job](/es/api/agent/v2/get-agent-job), [Send follow-up message](/es/api/agent/v2/send-message), [Get user feedback](/es/api/analytics/feedback), [Get assistant conversations](/es/api/analytics/assistant-conversations) y [Get assistant caller stats](/es/api/analytics/assistant-caller-stats).
+Usa la clave de la API de administrador para autenticar solicitudes a [Trigger update](/es/api/update/trigger), [Get update status](/es/api/update/status), [Trigger preview deployment](/es/api/preview/trigger), [Create agent job](/es/api/agent/v2/create-agent-job), [Get agent job](/es/api/agent/v2/get-agent-job), [Send follow-up message](/es/api/agent/v2/send-message), [Get user feedback](/es/api/analytics/feedback), [Get assistant conversations](/es/api/analytics/assistant-conversations) y [Get assistant caller stats](/es/api/analytics/assistant-caller-stats).
Las claves de la API de administrador comienzan con el prefijo `mint_`.
diff --git a/es/api/preview/trigger.mdx b/es/api/preview/trigger.mdx
new file mode 100644
index 000000000..b02e2aa7d
--- /dev/null
+++ b/es/api/preview/trigger.mdx
@@ -0,0 +1,28 @@
+---
+title: "Activar implementación de vista previa"
+description: "Crea o actualiza una implementación de vista previa para una rama específica y revisa los cambios en la documentación antes de fusionarlos a producción."
+openapi: "/es/openapi.json POST /project/preview/{projectId}"
+keywords: ["preview", "preview deployment", "branch preview", "staging"]
+---
+
+
+ Las implementaciones de vista previa están disponibles en los [planes Pro y Enterprise](https://mintlify.com/pricing?ref=preview-deployments).
+
+
+Usa este endpoint para crear o actualizar de forma programática una implementación de vista previa para una rama de Git. Si ya existe una vista previa para la rama especificada, el endpoint activa una reimplementación en lugar de crear un duplicado.
+
+La respuesta incluye un `statusId` que puedes pasar a [Get deployment status](/es/api/update/status) para rastrear el progreso de la implementación.
+
+
+ ## Casos de uso
+
+
+- **Pipelines CI/CD**: Crea automáticamente implementaciones de vista previa cuando se abren o actualizan solicitudes de extracción.
+- **Vistas previas programadas**: Genera vistas previas de ramas de funcionalidades de larga duración de forma programada.
+- **Herramientas personalizadas**: Integra la creación de vistas previas en flujos de trabajo internos o bots de Slack.
+
+
+ ## Límites de tasa
+
+
+Este endpoint permite hasta 5 solicitudes por minuto por organización.
diff --git a/es/deploy/preview-deployments.mdx b/es/deploy/preview-deployments.mdx
index 55eea3a6a..c783fd77e 100644
--- a/es/deploy/preview-deployments.mdx
+++ b/es/deploy/preview-deployments.mdx
@@ -46,6 +46,12 @@ Puedes crear manualmente una vista previa para cualquier branch.
4. Ingresa el nombre del branch que quieres previsualizar.
5. Selecciona **Create preview**.
+
+ ### API
+
+
+También puedes crear implementaciones de vista previa de forma programática usando el endpoint de la API [Trigger preview deployment](/es/api/preview/trigger). Esto es útil para integrar la creación de vistas previas en pipelines CI/CD o herramientas personalizadas.
+
## Volver a implementar una vista previa
diff --git a/es/openapi.json b/es/openapi.json
index a130df6b7..fb73511b4 100644
--- a/es/openapi.json
+++ b/es/openapi.json
@@ -214,6 +214,93 @@
}
}
}
+ },
+ "/project/preview/{projectId}": {
+ "post": {
+ "summary": "Activar implementación de vista previa",
+ "description": "Crea o actualiza una implementación de vista previa para una rama específica. Si ya existe una vista previa para la rama, se activa una reimplementación. Devuelve un ID de estado para hacer seguimiento del progreso y la URL de la vista previa.",
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "El ID de tu proyecto. Puedes copiarlo de la página de [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) de tu dashboard.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": ["branch"],
+ "properties": {
+ "branch": {
+ "type": "string",
+ "description": "El nombre de la rama de Git para la cual crear una implementación de vista previa.",
+ "minLength": 1
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Implementación de vista previa puesta en cola correctamente.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "statusId": {
+ "type": "string",
+ "description": "El ID de estado para hacer seguimiento de la implementación de vista previa. Úsalo con el endpoint [Get deployment status](/es/api/update/status)."
+ },
+ "previewUrl": {
+ "type": "string",
+ "description": "La URL donde se aloja la implementación de vista previa."
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Solicitud no válida. El campo `branch` es obligatorio.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Las implementaciones de vista previa no están disponibles en tu plan actual.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"components": {
diff --git a/fr.json b/fr.json
index 4d84fcbf5..b1a5e4e6d 100644
--- a/fr.json
+++ b/fr.json
@@ -340,7 +340,8 @@
"icon": "activity",
"pages": [
"fr/api/update/trigger",
- "fr/api/update/status"
+ "fr/api/update/status",
+ "fr/api/preview/trigger"
]
},
{
diff --git a/fr/api/introduction.mdx b/fr/api/introduction.mdx
index 2c64797a6..fcac2bf19 100644
--- a/fr/api/introduction.mdx
+++ b/fr/api/introduction.mdx
@@ -12,6 +12,7 @@ L'API REST (Representational State Transfer) de Mintlify vous permet d'interagir
* [Trigger update](/fr/api/update/trigger): Déclenchez une mise à jour de votre site quand vous le souhaitez.
* [Get update status](/fr/api/update/status): Récupérez le statut d'une mise à jour et d'autres détails sur votre documentation.
+* [Trigger preview deployment](/fr/api/preview/trigger): Créez ou mettez à jour un déploiement de prévisualisation pour une branche spécifique.
* [Create agent job](/fr/api/agent/v2/create-agent-job): Créez une tâche d'agent pour modifier automatiquement votre documentation.
* [Get agent job](/fr/api/agent/v2/get-agent-job): Récupérez les détails et le statut d'une tâche d'agent spécifique.
* [Send follow-up message](/fr/api/agent/v2/send-message): Envoyez un message de suivi à une tâche d'agent existante.
@@ -28,6 +29,7 @@ L'API REST (Representational State Transfer) de Mintlify vous permet d'interagir
* **Déploiements automatisés** : Déclenchez les mises à jour du site à intervalles réguliers ou lorsqu'un événement se produit avec [Trigger update](/fr/api/update/trigger) et [Get update status](/fr/api/update/status).
* **Intégration CI/CD** : Mettez à jour la documentation dans le cadre de votre pipeline de déploiement lorsque le code change avec [Trigger update](/fr/api/update/trigger).
+* **Déploiements de prévisualisation** : Créez ou mettez à jour des déploiements de prévisualisation de manière programmatique dans votre pipeline CI/CD avec [Trigger preview deployment](/fr/api/preview/trigger).
* **Intégrations personnalisées** : Intégrez l'Assistant IA à votre produit, portail d'assistance ou outils internes avec [Create assistant message](/fr/api/assistant/create-assistant-message-v2), [Search documentation](/fr/api/assistant/search) et [Get page content](/fr/api/assistant/get-page-content).
* **Édition automatisée** : Utilisez des jobs d'agent pour mettre à jour la documentation de manière programmatique et à grande échelle avec [Create agent job](/fr/api/agent/v2/create-agent-job), [Get agent job](/fr/api/agent/v2/get-agent-job), et [Send follow-up message](/fr/api/agent/v2/send-message).
* **Export Analytics** : Exportez les retours utilisateurs, les conversations de l'Assistant et les données de visiteurs pour une analyse externe avec [Get user feedback](/fr/api/analytics/feedback), [Get assistant conversations](/fr/api/analytics/assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/assistant-caller-stats).
@@ -44,7 +46,7 @@ Vous pouvez créer jusqu'à 10 clés d'API par heure et par organisation.
### Clé d'API administrateur
-Utilisez la clé d'API administrateur pour authentifier les requêtes vers [Trigger update](/fr/api/update/trigger), [Get update status](/fr/api/update/status), [Create agent job](/fr/api/agent/v2/create-agent-job), [Get agent job](/fr/api/agent/v2/get-agent-job), [Send follow-up message](/fr/api/agent/v2/send-message), [Get user feedback](/fr/api/analytics/feedback), [Get assistant conversations](/fr/api/analytics/assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/assistant-caller-stats).
+Utilisez la clé d'API administrateur pour authentifier les requêtes vers [Trigger update](/fr/api/update/trigger), [Get update status](/fr/api/update/status), [Trigger preview deployment](/fr/api/preview/trigger), [Create agent job](/fr/api/agent/v2/create-agent-job), [Get agent job](/fr/api/agent/v2/get-agent-job), [Send follow-up message](/fr/api/agent/v2/send-message), [Get user feedback](/fr/api/analytics/feedback), [Get assistant conversations](/fr/api/analytics/assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/assistant-caller-stats).
Les clés d'API administrateur commencent par le préfixe `mint_`.
diff --git a/fr/api/preview/trigger.mdx b/fr/api/preview/trigger.mdx
new file mode 100644
index 000000000..bf0a33ed0
--- /dev/null
+++ b/fr/api/preview/trigger.mdx
@@ -0,0 +1,28 @@
+---
+title: "Déclencher un déploiement de prévisualisation"
+description: "Créez ou mettez à jour un déploiement de prévisualisation pour une branche spécifique afin de vérifier les modifications de documentation avant la mise en production."
+openapi: "/fr/openapi.json POST /project/preview/{projectId}"
+keywords: ["preview", "preview deployment", "branch preview", "staging"]
+---
+
+
+ Les déploiements de prévisualisation sont disponibles avec les [offres Pro et Enterprise](https://mintlify.com/pricing?ref=preview-deployments).
+
+
+Utilisez cet endpoint pour créer ou mettre à jour de manière programmatique un déploiement de prévisualisation pour une branche Git. Si une prévisualisation existe déjà pour la branche spécifiée, l'endpoint déclenche un redéploiement au lieu de créer un doublon.
+
+La réponse inclut un `statusId` que vous pouvez transmettre à [Get deployment status](/fr/api/update/status) pour suivre la progression du déploiement.
+
+
+ ## Cas d'utilisation
+
+
+- **Pipelines CI/CD** : Créez automatiquement des déploiements de prévisualisation lorsque des pull requests sont ouvertes ou mises à jour.
+- **Prévisualisations planifiées** : Générez des prévisualisations de branches de fonctionnalités de longue durée selon un calendrier.
+- **Outillage personnalisé** : Intégrez la création de prévisualisations dans des workflows internes ou des bots Slack.
+
+
+ ## Limites de débit
+
+
+Cet endpoint autorise jusqu'à 5 requêtes par minute et par organisation.
diff --git a/fr/deploy/preview-deployments.mdx b/fr/deploy/preview-deployments.mdx
index 6537b883f..0834cbaa0 100644
--- a/fr/deploy/preview-deployments.mdx
+++ b/fr/deploy/preview-deployments.mdx
@@ -46,6 +46,12 @@ Vous pouvez créer manuellement un aperçu pour n’importe quelle branche.
4. Entrez le nom de la branche à prévisualiser.
5. Sélectionnez **Create preview**.
+
+ ### API
+
+
+Vous pouvez également créer des déploiements de prévisualisation de manière programmatique en utilisant l'endpoint de l'API [Trigger preview deployment](/fr/api/preview/trigger). Cela est utile pour intégrer la création de prévisualisations dans des pipelines CI/CD ou des outils personnalisés.
+
## Redéployer un aperçu
diff --git a/fr/openapi.json b/fr/openapi.json
index 90e207123..7dd1463cb 100644
--- a/fr/openapi.json
+++ b/fr/openapi.json
@@ -214,6 +214,93 @@
}
}
}
+ },
+ "/project/preview/{projectId}": {
+ "post": {
+ "summary": "Déclencher un déploiement de prévisualisation",
+ "description": "Créez ou mettez à jour un déploiement de prévisualisation pour une branche spécifique. Si une prévisualisation existe déjà pour la branche, un redéploiement est déclenché. Retourne un identifiant de statut pour suivre la progression et l'URL de la prévisualisation.",
+ "parameters": [
+ {
+ "name": "projectId",
+ "in": "path",
+ "description": "Identifiant de votre projet. Vous pouvez le copier à partir de la page [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) de votre Dashboard.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": ["branch"],
+ "properties": {
+ "branch": {
+ "type": "string",
+ "description": "Le nom de la branche Git pour laquelle créer un déploiement de prévisualisation.",
+ "minLength": 1
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "description": "Déploiement de prévisualisation mis en file d'attente avec succès.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "statusId": {
+ "type": "string",
+ "description": "L'identifiant de statut pour suivre le déploiement de prévisualisation. Utilisez-le avec l'endpoint [Get deployment status](/fr/api/update/status)."
+ },
+ "previewUrl": {
+ "type": "string",
+ "description": "L'URL à laquelle le déploiement de prévisualisation est hébergé."
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Requête non valide. Le champ `branch` est obligatoire.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Les déploiements de prévisualisation ne sont pas disponibles avec votre offre actuelle.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"components": {
diff --git a/zh.json b/zh.json
index 270672fa2..f17dd5778 100644
--- a/zh.json
+++ b/zh.json
@@ -340,7 +340,8 @@
"icon": "activity",
"pages": [
"zh/api/update/trigger",
- "zh/api/update/status"
+ "zh/api/update/status",
+ "zh/api/preview/trigger"
]
},
{
diff --git a/zh/api/introduction.mdx b/zh/api/introduction.mdx
index 593d00ef1..72638d821 100644
--- a/zh/api/introduction.mdx
+++ b/zh/api/introduction.mdx
@@ -12,6 +12,7 @@ Mintlify 的 REST（Representational State Transfer）API 让你可以以编程
* [Trigger update](/zh/api/update/trigger)：在需要时触发您站点的更新。
* [Get update status](/zh/api/update/status)：获取某次更新的状态以及与您的文档相关的其他详细信息。
+* [Trigger preview deployment](/zh/api/preview/trigger)：为特定分支创建或更新预览部署。
* [Create agent job](/zh/api/agent/v2/create-agent-job)：创建一个代理任务以自动编辑您的文档。
* [Get agent job](/zh/api/agent/v2/get-agent-job)：获取特定代理任务的详细信息和状态。
* [Send follow-up message](/zh/api/agent/v2/send-message)：向已有的代理任务发送后续消息。
@@ -28,6 +29,7 @@ Mintlify 的 REST（Representational State Transfer）API 让你可以以编程
* **自动化部署**：使用 [Trigger update](/zh/api/update/trigger) 和 [Get update status](/zh/api/update/status)，在设定的时间间隔或当特定事件发生时触发站点更新。
* **CI/CD 集成**：在代码变更时，将文档更新作为部署流水线的一部分来执行，使用 [Trigger update](/zh/api/update/trigger)。
+* **预览部署**：使用 [Trigger preview deployment](/zh/api/preview/trigger)，在 CI/CD 流水线中以编程方式创建或更新预览部署。
* **自定义集成**：使用 [Create assistant message](/zh/api/assistant/create-assistant-message-v2)、[Search documentation](/zh/api/assistant/search) 和 [Get page content](/zh/api/assistant/get-page-content)，将 AI 助手嵌入到你的产品、支持门户或内部工具中。
* **自动化编辑**：使用 agent 任务，以编程方式大规模更新文档，配合 [Create agent job](/zh/api/agent/v2/create-agent-job)、[Get agent job](/zh/api/agent/v2/get-agent-job) 和 [Send follow-up message](/zh/api/agent/v2/send-message)。
* **Analytics 导出**：使用 [Get user feedback](/zh/api/analytics/feedback)、[Get assistant conversations](/zh/api/analytics/assistant-conversations) 和 [Get assistant caller stats](/zh/api/analytics/assistant-caller-stats)，导出反馈、助手会话和调用方统计数据以进行外部分析。
@@ -44,7 +46,7 @@ Mintlify 的 REST（Representational State Transfer）API 让你可以以编程
### 管理员 API key
-使用管理员 API key 对发送到 [Trigger update](/zh/api/update/trigger)、[Get update status](/zh/api/update/status)、[Create agent job](/zh/api/agent/v2/create-agent-job)、[Get agent job](/zh/api/agent/v2/get-agent-job)、[Send follow-up message](/zh/api/agent/v2/send-message)、[Get user feedback](/zh/api/analytics/feedback)、[Get assistant conversations](/zh/api/analytics/assistant-conversations) 和 [Get assistant caller stats](/zh/api/analytics/assistant-caller-stats) 的请求进行身份验证。
+使用管理员 API key 对发送到 [Trigger update](/zh/api/update/trigger)、[Get update status](/zh/api/update/status)、[Trigger preview deployment](/zh/api/preview/trigger)、[Create agent job](/zh/api/agent/v2/create-agent-job)、[Get agent job](/zh/api/agent/v2/get-agent-job)、[Send follow-up message](/zh/api/agent/v2/send-message)、[Get user feedback](/zh/api/analytics/feedback)、[Get assistant conversations](/zh/api/analytics/assistant-conversations) 和 [Get assistant caller stats](/zh/api/analytics/assistant-caller-stats) 的请求进行身份验证。
管理员 API key 以 `mint_` 前缀开头。
diff --git a/zh/api/preview/trigger.mdx b/zh/api/preview/trigger.mdx
new file mode 100644
index 000000000..c622d0ed5
--- /dev/null
+++ b/zh/api/preview/trigger.mdx
@@ -0,0 +1,28 @@
+---
+title: "触发预览部署"
+description: "为特定分支创建或更新预览部署，以便在合并到生产环境之前审阅文档更改。"
+openapi: "/zh/openapi.json POST /project/preview/{projectId}"
+keywords: ["preview", "preview deployment", "branch preview", "staging"]
+---
+
+
+ 预览部署适用于 [Pro 和 Enterprise 方案](https://mintlify.com/pricing?ref=preview-deployments)。
+
+
+使用此端点以编程方式为 Git 分支创建或更新预览部署。如果指定分支已存在预览，该端点将触发重新部署，而不会创建重复项。
+
+响应中包含一个 `statusId`，你可以将其传递给 [Get deployment status](/zh/api/update/status) 以跟踪部署进度。
+
+
+ ## 用例
+
+
+- **CI/CD 流水线**：在拉取请求被打开或更新时自动创建预览部署。
+- **定时预览**：按计划为长期运行的功能分支生成预览。
+- **自定义工具**：将预览创建集成到内部工作流或 Slack 机器人中。
+
+
+ ## 速率限制
+
+
+此端点允许每个组织每分钟最多 5 个请求。
diff --git a/zh/deploy/preview-deployments.mdx b/zh/deploy/preview-deployments.mdx
index d4af90fa2..753bb481d 100644
--- a/zh/deploy/preview-deployments.mdx
+++ b/zh/deploy/preview-deployments.mdx
@@ -46,6 +46,12 @@ keywords: ["preview URLs", "pull request previews", "branch previews", "staging
4. 输入要预览的 branch 名称。
5. 选择 **Create preview**。
+
+ ### API
+
+
+你也可以使用 [Trigger preview deployment](/zh/api/preview/trigger) API 端点以编程方式创建预览部署。这对于将预览创建集成到 CI/CD 流水线或自定义工具中非常有用。
+
## 重新部署预览
diff --git a/zh/openapi.json b/zh/openapi.json
index a6ec005e1..0e8f0db46 100644
--- a/zh/openapi.json
+++ b/zh/openapi.json
@@ -214,6 +214,93 @@
}
}
}
+ },
+ "/project/preview/{projectId}": {
+ "post": {
+ "summary": "触发预览部署",
+ "description": "为特定分支创建或更新预览部署。如果该分支已有预览，则会触发重新部署。返回用于跟踪进度的状态 ID 和预览 URL。",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"components": {