mintlify · mintlify · Apr 1, 2026 · Apr 1, 2026
diff --git a/api/introduction.mdx b/api/introduction.mdx
@@ -4,9 +4,9 @@
 keywords: ["REST API", "endpoints", "API keys"]
 ---

 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.
@@ -16,6 +16,7 @@
 - [Create assistant message](/api/assistant/create-assistant-message-v2): Embed the assistant, trained on your docs, into any application of your choosing.
 - [Search documentation](/api/assistant/search): Search through your documentation.
 - [Get page content](/api/assistant/get-page-content): Retrieve the full text content of a documentation page.
+- [Create preview deployment](/api/preview/create): Create a preview deployment from a Git branch.
 - [Get user feedback](/api/analytics/feedback): Export user feedback from your documentation.
 - [Get feedback by page](/api/analytics/feedback-by-page): Export feedback counts aggregated by page.
 - [Get assistant conversations](/api/analytics/assistant-conversations): Export AI assistant conversation history.
@@ -27,6 +28,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 with [Create preview deployment](/api/preview/create).
 - **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 search queries](/api/analytics/searches), [Get page views](/api/analytics/views), and [Get unique visitors](/api/analytics/visitors).
@@ -39,7 +41,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 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), [Create preview deployment](/api/preview/create), [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 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/create.mdx b/api/preview/create.mdx
@@ -0,0 +1,6 @@
+---
+title: "Create preview deployment"
+description: "Create a preview deployment from a Git branch to preview documentation changes before merging."
+openapi: "/openapi.json POST /project/{projectId}/preview"
+keywords: ["preview", "deployment", "create", "branch"]
+---
diff --git a/docs.json b/docs.json
@@ -369,6 +369,13 @@
                   "api/assistant/get-page-content"
                 ]
               },
+              {
+                "group": "Preview deployments",
+                "icon": "eye",
+                "pages": [
+                  "api/preview/create"
+                ]
+              },
               {
                 "group": "Analytics",
                 "icon": "chart-line",
@@ -746,6 +753,13 @@
                   "fr/api/assistant/get-page-content"
                 ]
               },
+              {
+                "group": "Déploiements de prévisualisation",
+                "icon": "eye",
+                "pages": [
+                  "fr/api/preview/create"
+                ]
+              },
               {
                 "group": "Analytics",
                 "icon": "chart-line",
@@ -1119,6 +1133,13 @@
                   "es/api/assistant/get-page-content"
                 ]
               },
+              {
+                "group": "Despliegues de vista previa",
+                "icon": "eye",
+                "pages": [
+                  "es/api/preview/create"
+                ]
+              },
               {
                 "group": "Analytics",
                 "icon": "chart-line",
@@ -1492,6 +1513,13 @@
                   "zh/api/assistant/get-page-content"
                 ]
               },
+              {
+                "group": "预览部署",
+                "icon": "eye",
+                "pages": [
+                  "zh/api/preview/create"
+                ]
+              },
               {
                 "group": "数据分析",
                 "icon": "chart-line",

diff --git a/es/api/introduction.mdx b/es/api/introduction.mdx
@@ -18,6 +18,7 @@ La REST (Representational State Transfer) API de Mintlify te permite interactuar
 * [Create assistant message](/es/api/assistant/create-assistant-message-v2): Integra el assistant, entrenado con tu documentación, en cualquier aplicación que elijas.
 * [Search documentation](/es/api/assistant/search): Busca en tu documentación.
 * [Get page content](/es/api/assistant/get-page-content): Recupera el contenido de texto completo de una página de documentación.
+* [Create preview deployment](/es/api/preview/create): Crea un despliegue de vista previa desde una rama de Git.
 * [Get user feedback](/es/api/analytics/feedback): Exporta los comentarios de los usuarios de tu documentación.
 * [Get assistant conversations](/es/api/analytics/assistant-conversations): Exporta el historial de conversaciones del Asistente de IA.
 
@@ -27,6 +28,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 de forma programática con [Create preview deployment](/es/api/preview/create).
 * **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 y conversaciones del Asistente de IA para análisis externo con [Get user feedback](/es/api/analytics/feedback) y [Get assistant conversations](/es/api/analytics/assistant-conversations).
@@ -43,7 +45,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) y [Get assistant conversations](/es/api/analytics/assistant-conversations).
+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 preview deployment](/es/api/preview/create), [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) y [Get assistant conversations](/es/api/analytics/assistant-conversations).
 
 Las claves de la API de administrador comienzan con el prefijo `mint_`.
 

diff --git a/es/api/preview/create.mdx b/es/api/preview/create.mdx
@@ -0,0 +1,6 @@
+---
+title: "Crear despliegue de vista previa"
+description: "Crea un despliegue de vista previa desde una rama de Git para previsualizar los cambios en la documentación antes de fusionar."
+openapi: "/es/openapi.json POST /project/{projectId}/preview"
+keywords: ["vista previa", "despliegue", "crear", "rama"]
+---
diff --git a/es/openapi.json b/es/openapi.json
@@ -214,6 +214,86 @@
           }
         }
       }
+    },
+    "/project/{projectId}/preview": {
+      "post": {
+        "summary": "Crear despliegue de vista previa",
+        "description": "Crea un despliegue de vista previa para una rama específica. El despliegue se construye de forma asíncrona. Usa el `statusId` devuelto para consultar el estado de la construcción. Requiere el derecho `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": "La rama de Git desde la cual crear un despliegue de vista previa.",
+                    "example": "feature/my-branch"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "202": {
+            "description": "La creación del despliegue de vista previa ha sido puesta en cola.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "statusId": {
+                      "type": "string",
+                      "description": "El ID de estado para consultar el progreso de la construcción."
+                    },
+                    "previewDeploymentId": {
+                      "type": "string",
+                      "description": "El identificador único del despliegue de vista previa creado."
+                    },
+                    "subdomain": {
+                      "type": "string",
+                      "description": "El subdominio asignado al despliegue de vista previa."
+                    },
+                    "previewUrl": {
+                      "type": "string",
+                      "description": "La URL donde el despliegue de vista previa es accesible."
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Solicitud inválida. La rama falta o el proyecto de origen es un despliegue de vista previa.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {

diff --git a/fr/api/introduction.mdx b/fr/api/introduction.mdx
@@ -18,6 +18,7 @@ L'API REST (Representational State Transfer) de Mintlify vous permet d'interagir
 * [Create assistant message](/fr/api/assistant/create-assistant-message-v2): Intégrez l'Assistant, entraîné sur votre documentation, dans n'importe quelle application de votre choix.
 * [Search documentation](/fr/api/assistant/search): Effectuez une recherche dans votre documentation.
 * [Get page content](/fr/api/assistant/get-page-content): Récupérez le contenu textuel complet d'une page de documentation.
+* [Create preview deployment](/fr/api/preview/create) : Créez un déploiement de prévisualisation à partir d'une branche Git.
 * [Get user feedback](/fr/api/analytics/feedback): Exportez les retours utilisateurs issus de votre documentation.
 * [Get assistant conversations](/fr/api/analytics/assistant-conversations): Exportez l'historique des conversations de l'Assistant IA.
 
@@ -27,6 +28,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 de manière programmatique avec [Create preview deployment](/fr/api/preview/create).
 * **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 et les conversations avec l'Assistant pour une analyse externe avec [Get user feedback](/fr/api/analytics/feedback) et [Get assistant conversations](/fr/api/analytics/assistant-conversations).
@@ -43,7 +45,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) et [Get assistant conversations](/fr/api/analytics/assistant-conversations).
+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 preview deployment](/fr/api/preview/create), [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) et [Get assistant conversations](/fr/api/analytics/assistant-conversations).
 
 Les clés d'API administrateur commencent par le préfixe `mint_`.
 

diff --git a/fr/api/preview/create.mdx b/fr/api/preview/create.mdx
@@ -0,0 +1,6 @@
+---
+title: "Créer un déploiement de prévisualisation"
+description: "Créez un déploiement de prévisualisation à partir d'une branche Git pour prévisualiser les modifications de la documentation avant de les fusionner."
+openapi: "/fr/openapi.json POST /project/{projectId}/preview"
+keywords: ["prévisualisation", "déploiement", "créer", "branche"]
+---