mintlify · mintlify · Apr 17, 2026
diff --git a/api/introduction.mdx b/api/introduction.mdx
@@ -6,10 +6,11 @@

 The Mintlify REST (Representational State Transfer) API enables you to programmatically interact with your documentation, trigger updates, embed AI-powered chat experiences, and export analytics data.

 ## Endpoints
 
 - [Trigger update](/api/update/trigger): Trigger an update of your site when desired.
 - [Get update status](/api/update/status): Get the status of an update and other details about your docs.
+- [Trigger preview deployment](/api/preview/trigger): Create or rebuild a preview deployment for a specific branch.
 - [Create agent job](/api/agent/v2/create-agent-job): Create an agent job to automatically edit your documentation.
 - [Get agent job](/api/agent/v2/get-agent-job): Retrieve the details and status of a specific agent job.
 - [Send follow-up message](/api/agent/v2/send-message): Send a follow-up message to an existing agent job.
@@ -28,6 +29,7 @@
 
 - **Automated deployments**: Trigger site updates at set intervals or when events occur with [Trigger update](/api/update/trigger) and [Get update status](/api/update/status).
 - **CI/CD integration**: Update documentation as part of your deployment pipeline when code changes with [Trigger update](/api/update/trigger).
+- **Preview deployments**: Programmatically create preview deployments for branches in your CI/CD pipeline with [Trigger preview deployment](/api/preview/trigger).
 - **Custom integrations**: Embed the AI assistant into your product, support portal, or internal tools with [Create assistant message](/api/assistant/create-assistant-message-v2), [Search documentation](/api/assistant/search), and [Get page content](/api/assistant/get-page-content).
 - **Automated editing**: Use agent jobs to programmatically update documentation at scale with [Create agent job](/api/agent/v2/create-agent-job), [Get agent job](/api/agent/v2/get-agent-job), and [Send follow-up message](/api/agent/v2/send-message).
 - **Analytics export**: Export feedback, assistant conversations, search analytics, page views, and visitor data for external analysis with [Get user feedback](/api/analytics/feedback), [Get feedback by page](/api/analytics/feedback-by-page), [Get assistant conversations](/api/analytics/assistant-conversations), [Get assistant caller stats](/api/analytics/assistant-caller-stats), [Get search queries](/api/analytics/searches), [Get page views](/api/analytics/views), and [Get unique visitors](/api/analytics/visitors).
@@ -40,7 +42,7 @@
 
 ### Admin API key
 
-Use the admin API key to authenticate requests to [Trigger update](/api/update/trigger), [Get update status](/api/update/status), [Create agent job](/api/agent/v2/create-agent-job), [Get agent job](/api/agent/v2/get-agent-job), [Send follow-up message](/api/agent/v2/send-message), [Get user feedback](/api/analytics/feedback), [Get feedback by page](/api/analytics/feedback-by-page), [Get assistant conversations](/api/analytics/assistant-conversations), [Get assistant caller stats](/api/analytics/assistant-caller-stats), [Get search queries](/api/analytics/searches), [Get page views](/api/analytics/views), and [Get unique visitors](/api/analytics/visitors).
+Use the admin API key to authenticate requests to [Trigger update](/api/update/trigger), [Get update status](/api/update/status), [Trigger preview deployment](/api/preview/trigger), [Create agent job](/api/agent/v2/create-agent-job), [Get agent job](/api/agent/v2/get-agent-job), [Send follow-up message](/api/agent/v2/send-message), [Get user feedback](/api/analytics/feedback), [Get feedback by page](/api/analytics/feedback-by-page), [Get assistant conversations](/api/analytics/assistant-conversations), [Get assistant caller stats](/api/analytics/assistant-caller-stats), [Get search queries](/api/analytics/searches), [Get page views](/api/analytics/views), and [Get unique visitors](/api/analytics/visitors).
 
 Admin API keys begin with the `mint_` prefix. 
 

diff --git a/api/preview/trigger.mdx b/api/preview/trigger.mdx
@@ -0,0 +1,6 @@
+---
+title: "Trigger preview deployment"
+description: "Create or rebuild a preview deployment for a specific branch programmatically."
+openapi: "/openapi.json POST /project/preview/{projectId}"
+keywords: [ "preview", "deployment", "branch", "programmatic" ]
+---
diff --git a/docs.json b/docs.json
@@ -362,7 +362,8 @@
                 "icon": "activity",
                 "pages": [
                   "api/update/trigger",
-                  "api/update/status"
+                  "api/update/status",
+                  "api/preview/trigger"
                 ]
               },
               {
@@ -747,7 +748,8 @@
                 "icon": "activity",
                 "pages": [
                   "fr/api/update/trigger",
-                  "fr/api/update/status"
+                  "fr/api/update/status",
+                  "fr/api/preview/trigger"
                 ]
               },
               {
@@ -1128,7 +1130,8 @@
                 "icon": "activity",
                 "pages": [
                   "es/api/update/trigger",
-                  "es/api/update/status"
+                  "es/api/update/status",
+                  "es/api/preview/trigger"
                 ]
               },
               {
@@ -1509,7 +1512,8 @@
                 "icon": "activity",
                 "pages": [
                   "zh/api/update/trigger",
-                  "zh/api/update/status"
+                  "zh/api/update/status",
+                  "zh/api/preview/trigger"
                 ]
               },
               {

diff --git 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 reconstruye un despliegue 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).
+* **Despliegues de vista previa**: Crea despliegues de vista previa para ramas 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
 </div>
 
-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
@@ -0,0 +1,6 @@
+---
+title: "Iniciar despliegue de vista previa"
+description: "Crea o reconstruye un despliegue de vista previa para una rama específica de forma programática."
+openapi: "/es/openapi.json POST /project/preview/{projectId}"
+keywords: [ "vista previa", "despliegue", "rama", "programático" ]
+---
diff --git a/es/openapi.json b/es/openapi.json
@@ -214,6 +214,95 @@
           }
         }
       }
+    },
+    "/project/preview/{projectId}": {
+      "post": {
+        "summary": "Iniciar despliegue de vista previa",
+        "description": "Crea o reconstruye un despliegue de vista previa para una rama específica. Si ya existe un despliegue de vista previa para la rama dada, lo reutiliza y activa una reconstrucción. Devuelve un ID de estado para consultar el progreso y la URL de vista previa. Requiere el derecho de Preview Deployments.",
+        "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 para la cual crear un despliegue de vista previa.",
+                    "minLength": 1
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "202": {
+            "description": "Despliegue de vista previa puesto en cola correctamente",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "statusId": {
+                      "type": "string",
+                      "description": "El ID de estado del despliegue de vista previa activado. Úsalo con el endpoint [Obtener el estado del despliegue](/es/api/update/status) para consultar el progreso."
+                    },
+                    "previewUrl": {
+                      "type": "string",
+                      "description": "La URL donde se podrá acceder al despliegue de vista previa."
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Cuerpo de solicitud inválido",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string",
+                      "example": "branch is required"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Los despliegues de vista previa no están disponibles en tu plan actual",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string",
+                      "example": "Preview deployments are not available on your current plan."
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {

diff --git 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 reconstruisez 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 des déploiements de prévisualisation pour des branches 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
 </div>
 
-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
@@ -0,0 +1,6 @@
+---
+title: "Déclencher un déploiement de prévisualisation"
+description: "Créez ou reconstruisez un déploiement de prévisualisation pour une branche spécifique de manière programmatique."
+openapi: "/fr/openapi.json POST /project/preview/{projectId}"
+keywords: [ "prévisualisation", "déploiement", "branche", "programmatiquement" ]
+---