From 87f452b02e2a12f3b8b009068fb1f354419703cc Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 7 Jul 2026 10:11:43 +0000 Subject: [PATCH 01/10] docs: close reader-question gaps in recently changed pages --- agent/index.mdx | 9 +++++++++ api/introduction.mdx | 20 ++++++++++++++++++++ deploy/authentication-setup.mdx | 11 +++++++++++ deploy/export.mdx | 8 ++++++++ deploy/preview-deployments.mdx | 2 ++ 5 files changed, 50 insertions(+) diff --git a/agent/index.mdx b/agent/index.mdx index 195bf5c4d..3d103554b 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -20,6 +20,15 @@ The agent is an AI tool that creates pull requests with proposed changes to your All changes go through pull requests. The agent never commits directly to your main branch. +## Send your first request + +1. Go to the [Agent](https://app.mintlify.com/products/agent) page in your dashboard to open the agent panel. +2. Describe what you want the agent to change or write in the message field. +3. Send the message. The agent starts working and comments on progress inside the panel. +4. When the agent finishes, review the pull request it opens against your docs repository. + +You can also trigger the agent from [Slack](/agent/slack), from [automations](/automations/index), or through the [Create agent job API](/api/agent/v2/create-agent-job). + ## What you can do with the agent Use the agent to: diff --git a/api/introduction.mdx b/api/introduction.mdx index e27b57833..245899e54 100644 --- a/api/introduction.mdx +++ b/api/introduction.mdx @@ -41,6 +41,26 @@ The Mintlify REST (Representational State Transfer) API enables you to programma - **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). +## Base URL + +All Mintlify REST API requests use the following base URL: + +``` +https://api.mintlify.com +``` + +## Making a request + +Authenticate every request by passing your API key in the `Authorization` header as a bearer token. For example: + +```bash +curl https://api.mintlify.com/v1/project/update/{projectId} \ + -H "Authorization: Bearer mint_YOUR_ADMIN_API_KEY" \ + -H "Content-Type: application/json" +``` + +Use the [admin API key](#admin-api-key) for deployment, agent, and analytics endpoints and the [assistant API key](#assistant-api-key) for assistant endpoints. See each endpoint's reference page for its full path, request body, and response schema. + ## Authentication Generate API keys on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Each API key belongs to an organization--you can use keys across multiple deployments within the same organization. diff --git a/deploy/authentication-setup.mdx b/deploy/authentication-setup.mdx index 9be6a9751..7cf7ec2b9 100644 --- a/deploy/authentication-setup.mdx +++ b/deploy/authentication-setup.mdx @@ -18,6 +18,17 @@ You can configure full authentication for all pages or partial authentication wh Authentication is only available for sites hosted on a custom domain or Mintlify subdomain. For example, `docs.example.com` or `example.mintlify.site`. Authentication is **not supported** for sites with a [custom subpath](/deploy/docs-subpath). For example, `example.com/docs`. +## Choose an authentication method + +Use this comparison to pick the method that fits your use case. See [Feature availability](#feature-availability) for how each method interacts with other Mintlify features. + +| Method | Best for | Plan | Group-based access | API playground pre-fill | Personalization | +| :--- | :--- | :--- | :---: | :---: | :---: | +| Password | Simple shared access with no per-user tracking | Pro or Enterprise | — | — | — | +| Private authentication | Internal docs for members of your Mintlify organization | All plans | — | — | — | +| OAuth 2.0 | Existing identity provider or SSO with per-user sessions | Enterprise | ✓ | ✓ | ✓ | +| JWT | Custom auth backend or embedded docs behind your own login | Enterprise | ✓ | ✓ | ✓ | + ## Configure authentication diff --git a/deploy/export.mdx b/deploy/export.mdx index f9b828487..312b1047e 100644 --- a/deploy/export.mdx +++ b/deploy/export.mdx @@ -45,6 +45,14 @@ mint export --output customer-docs.zip --groups enterprise The export only includes pages listed in your navigation. [Hidden pages](/organize/hidden-pages) are not included in the archive. +### Security considerations + +The exported archive is a static, unauthenticated bundle. Anyone with the zip file can view every page it contains. + +- The `--groups` flag controls which group-restricted pages Mintlify includes in the archive at export time. It does **not** enforce authentication after export. +- Only share archives with recipients who are allowed to see the content they contain. +- Regenerate and redistribute the archive to publish new changes—recipients running an older zip continue to see the older content. + ## What's in the zip The exported archive contains everything needed to view your docs offline: diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index 1d5c85854..c7668c152 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -111,6 +111,8 @@ Preview deployments stay live as long as their source branch exists in your repo Preview URLs are unique per branch. If you delete a preview and later recreate one for the same branch, Mintlify may issue a new URL. +Mintlify generates preview URLs automatically. The subdomain and domain are not configurable, and custom domains are reserved for your production deployment. + ## Troubleshooting preview deployments If your preview deployment fails, try these troubleshooting steps. From 5d2b971fe0a121b6eae777e916deb2d54b7ddab9 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 7 Jul 2026 10:16:42 +0000 Subject: [PATCH 02/10] docs: translate reader-question gap fixes (es, fr, zh) --- es/agent/index.mdx | 11 +++++++++++ es/api/introduction.mdx | 16 ++++++++++++++-- es/deploy/authentication-setup.mdx | 13 +++++++++++++ es/deploy/export.mdx | 10 ++++++++++ es/deploy/preview-deployments.mdx | 2 ++ fr/agent/index.mdx | 11 +++++++++++ fr/api/introduction.mdx | 16 ++++++++++++++-- fr/deploy/authentication-setup.mdx | 13 +++++++++++++ fr/deploy/export.mdx | 10 ++++++++++ fr/deploy/preview-deployments.mdx | 2 ++ zh/agent/index.mdx | 11 +++++++++++ zh/api/introduction.mdx | 16 ++++++++++++++-- zh/deploy/authentication-setup.mdx | 13 +++++++++++++ zh/deploy/export.mdx | 10 ++++++++++ zh/deploy/preview-deployments.mdx | 2 ++ 15 files changed, 150 insertions(+), 6 deletions(-) diff --git a/es/agent/index.mdx b/es/agent/index.mdx index d65d7f5f0..dd83b2832 100644 --- a/es/agent/index.mdx +++ b/es/agent/index.mdx @@ -18,6 +18,17 @@ El agente es una herramienta de IA que crea solicitudes de extracción (pull req Todos los cambios pasan por solicitudes de extracción (pull requests). El agente nunca realiza confirmaciones directamente en tu branch principal. +
+ ## Envía tu primera solicitud +
+ +1. Ve a la página [Agent](https://app.mintlify.com/products/agent) en tu dashboard para abrir el panel del agente. +2. Describe lo que quieres que el agente cambie o escriba en el campo del mensaje. +3. Envía el mensaje. El agente comienza a trabajar y comenta el progreso dentro del panel. +4. Cuando el agente termine, revisa la solicitud de extracción (pull request) que abre en el repositorio de tu documentación. + +También puedes activar el agente desde [Slack](/es/agent/slack), desde [automatizaciones](/es/automations/index) o mediante la [API para crear una tarea de agente](/es/api/agent/v2/create-agent-job). +
## Qué puedes hacer con el agente
diff --git a/es/api/introduction.mdx b/es/api/introduction.mdx index cc61989e3..9fe92d110 100644 --- a/es/api/introduction.mdx +++ b/es/api/introduction.mdx @@ -45,13 +45,25 @@ La REST (Representational State Transfer) API de Mintlify te permite interactuar ## URL base -Todos los endpoints de la API REST de Mintlify se sirven desde: +Todas las solicitudes a la API REST de Mintlify usan la siguiente URL base: ``` https://api.mintlify.com ``` -La página de referencia de cada endpoint indica la ruta completa y el método HTTP que se debe llamar. +
+ ## Hacer una solicitud +
+ +Autentica cada solicitud pasando tu API key en el encabezado `Authorization` como un bearer token. Por ejemplo: + +```bash +curl https://api.mintlify.com/v1/project/update/{projectId} \ + -H "Authorization: Bearer mint_YOUR_ADMIN_API_KEY" \ + -H "Content-Type: application/json" +``` + +Usa la [clave de la API de administrador](#admin-api-key) para los endpoints de implementación, agente y analítica, y la [key del Assistant API](#assistant-api-key) para los endpoints del assistant. Consulta la página de referencia de cada endpoint para conocer su ruta completa, el cuerpo de la solicitud y el esquema de respuesta.
## Autenticación diff --git a/es/deploy/authentication-setup.mdx b/es/deploy/authentication-setup.mdx index 3ab82b45d..f8c427f42 100644 --- a/es/deploy/authentication-setup.mdx +++ b/es/deploy/authentication-setup.mdx @@ -18,6 +18,19 @@ Puedes configurar autenticación completa para todas las páginas o autenticaci La autenticación solo está disponible para sitios alojados en un dominio personalizado o subdominio de Mintlify. Por ejemplo, `docs.ejemplo.com` o `ejemplo.mintlify.site`. La autenticación **no es compatible** para sitios con una [subruta personalizada](/es/deploy/docs-subpath). Por ejemplo, `ejemplo.com/docs`. +
+ ## Elige un método de autenticación +
+ +Usa esta comparación para elegir el método que se adapte a tu caso de uso. Consulta [Disponibilidad de funciones](#feature-availability) para ver cómo interactúa cada método con otras funciones de Mintlify. + +| Método | Ideal para | Plan | Control de acceso basado en grupos | Autocompletado del área de pruebas de la API | Personalización | +| :--- | :--- | :--- | :---: | :---: | :---: | +| Contraseña | Acceso compartido sencillo sin seguimiento por usuario | Pro o Enterprise | — | — | — | +| Autenticación privada | Documentación interna para miembros de tu organización de Mintlify | Todos los planes | — | — | — | +| OAuth 2.0 | Proveedor de identidad existente o SSO con sesiones por usuario | Enterprise | ✓ | ✓ | ✓ | +| JWT | Backend de autenticación personalizado o documentación integrada detrás de tu propio inicio de sesión | Enterprise | ✓ | ✓ | ✓ | +
## Configurar la autenticación
diff --git a/es/deploy/export.mdx b/es/deploy/export.mdx index 03df3532d..86797e101 100644 --- a/es/deploy/export.mdx +++ b/es/deploy/export.mdx @@ -51,6 +51,16 @@ mint export --output customer-docs.zip --groups enterprise La exportación solo incluye las páginas listadas en tu navegación. Las [páginas ocultas](/es/organize/hidden-pages) no se incluyen en el archivo. +
+ ### Consideraciones de seguridad +
+ +El archivo exportado es un paquete estático y sin autenticación. Cualquier persona que tenga el archivo zip puede ver todas las páginas que contiene. + +- El flag `--groups` controla qué páginas restringidas por grupo incluye Mintlify en el archivo al momento de exportar. **No** aplica autenticación después de la exportación. +- Comparte los archivos únicamente con destinatarios autorizados a ver el contenido que contienen. +- Regenera y vuelve a distribuir el archivo para publicar nuevos cambios: los destinatarios que ejecuten un zip anterior seguirán viendo el contenido anterior. +
## Qué contiene el zip
diff --git a/es/deploy/preview-deployments.mdx b/es/deploy/preview-deployments.mdx index 866ac83cd..f045fca23 100644 --- a/es/deploy/preview-deployments.mdx +++ b/es/deploy/preview-deployments.mdx @@ -132,6 +132,8 @@ Las implementaciones de vista previa se mantienen activas mientras la rama de or Las URLs de vista previa son únicas por rama. Si eliminas una vista previa y más tarde vuelves a crear otra para la misma rama, Mintlify puede emitir una nueva URL. +Mintlify genera las URLs de vista previa automáticamente. El subdominio y el dominio no son configurables, y los dominios personalizados están reservados para tu implementación en producción. +
## Solución de problemas con las implementaciones de vista previa
diff --git a/fr/agent/index.mdx b/fr/agent/index.mdx index a45a17211..d892e8625 100644 --- a/fr/agent/index.mdx +++ b/fr/agent/index.mdx @@ -18,6 +18,17 @@ L'agent est un outil d'IA qui crée des pull requests (demandes de fusion) avec Tous les changements passent par des pull requests (demandes de fusion). L'agent ne fait jamais de commit directement sur votre branche principale. +
+ ## Envoyer votre première requête +
+ +1. Accédez à la page [Agent](https://app.mintlify.com/products/agent) dans votre Dashboard pour ouvrir le panneau de l'agent. +2. Décrivez ce que vous souhaitez que l'agent modifie ou rédige dans le champ de message. +3. Envoyez le message. L'agent se met au travail et commente sa progression dans le panneau. +4. Une fois l'agent terminé, examinez la pull request (demande de fusion) qu'il ouvre sur le dépôt de votre documentation. + +Vous pouvez également déclencher l'agent depuis [Slack](/fr/agent/slack), depuis les [automatisations](/fr/automations/index) ou via l'[API Create agent job](/fr/api/agent/v2/create-agent-job). +
## Ce que vous pouvez faire avec l’agent
diff --git a/fr/api/introduction.mdx b/fr/api/introduction.mdx index 25c5acbe5..87039f49b 100644 --- a/fr/api/introduction.mdx +++ b/fr/api/introduction.mdx @@ -45,13 +45,25 @@ L'API REST (Representational State Transfer) de Mintlify vous permet d'interagir ## URL de base
-Tous les endpoints de l'API REST Mintlify sont accessibles depuis : +Toutes les requêtes vers l'API REST Mintlify utilisent l'URL de base suivante : ``` https://api.mintlify.com ``` -La page de référence de chaque endpoint indique le chemin complet et la méthode HTTP à appeler. +
+ ## Effectuer une requête +
+ +Authentifiez chaque requête en transmettant votre clé d'API dans l'en-tête `Authorization` sous forme de jeton bearer. Par exemple : + +```bash +curl https://api.mintlify.com/v1/project/update/{projectId} \ + -H "Authorization: Bearer mint_YOUR_ADMIN_API_KEY" \ + -H "Content-Type: application/json" +``` + +Utilisez la [clé d'API administrateur](#admin-api-key) pour les endpoints de déploiement, d'agent et d'analytique, et la [clé d'API de l'Assistant](#assistant-api-key) pour les endpoints de l'Assistant. Consultez la page de référence de chaque endpoint pour connaître son chemin complet, le corps de la requête et le schéma de la réponse.
## Authentification diff --git a/fr/deploy/authentication-setup.mdx b/fr/deploy/authentication-setup.mdx index 787b9e55d..ea6c1f87e 100644 --- a/fr/deploy/authentication-setup.mdx +++ b/fr/deploy/authentication-setup.mdx @@ -18,6 +18,19 @@ Vous pouvez configurer une authentification complète pour toutes les pages ou u L'authentification n'est disponible que pour les sites hébergés sur un domaine personnalisé ou un sous-domaine Mintlify. Par exemple, `docs.exemple.com` ou `exemple.mintlify.site`. L'authentification **n'est pas prise en charge** pour les sites avec un [sous-chemin personnalisé](/fr/deploy/docs-subpath). Par exemple, `exemple.com/docs`. +
+ ## Choisir une méthode d'authentification +
+ +Utilisez ce comparatif pour choisir la méthode adaptée à votre cas d'usage. Consultez [Disponibilité des fonctionnalités](#feature-availability) pour savoir comment chaque méthode interagit avec les autres fonctionnalités de Mintlify. + +| Méthode | Idéal pour | Offre | Accès basé sur les groupes | Pré-remplissage du bac à sable d'API | Personnalisation | +| :--- | :--- | :--- | :---: | :---: | :---: | +| Password | Accès partagé simple sans suivi par utilisateur | Pro ou Enterprise | — | — | — | +| Private authentication | Documentation interne pour les membres de votre organisation Mintlify | Toutes les offres | — | — | — | +| OAuth 2.0 | Fournisseur d'identité existant ou SSO avec sessions par utilisateur | Enterprise | ✓ | ✓ | ✓ | +| JWT | Backend d'authentification personnalisé ou documentation intégrée derrière votre propre connexion | Enterprise | ✓ | ✓ | ✓ | +
## Configurer l’authentification
diff --git a/fr/deploy/export.mdx b/fr/deploy/export.mdx index 62a47b826..fdf72d7c4 100644 --- a/fr/deploy/export.mdx +++ b/fr/deploy/export.mdx @@ -51,6 +51,16 @@ mint export --output customer-docs.zip --groups enterprise L'exportation inclut uniquement les pages listées dans votre navigation. Les [pages masquées](/fr/organize/hidden-pages) ne sont pas incluses dans l'archive. +
+ ### Considérations de sécurité +
+ +L'archive exportée est un bundle statique et non authentifié. Toute personne disposant du fichier zip peut consulter chaque page qu'il contient. + +- L'option `--groups` contrôle quelles pages à accès restreint par groupe Mintlify inclut dans l'archive au moment de l'exportation. Elle **n'applique pas** d'authentification après l'exportation. +- Ne partagez les archives qu'avec des destinataires autorisés à voir le contenu qu'elles contiennent. +- Régénérez et redistribuez l'archive pour publier de nouvelles modifications — les destinataires qui utilisent un zip plus ancien continueront à voir l'ancien contenu. +
## Contenu du zip
diff --git a/fr/deploy/preview-deployments.mdx b/fr/deploy/preview-deployments.mdx index 1e9ea987b..814b839dd 100644 --- a/fr/deploy/preview-deployments.mdx +++ b/fr/deploy/preview-deployments.mdx @@ -134,6 +134,8 @@ Les déploiements de prévisualisation restent disponibles tant que leur branche Les URL d'aperçu sont uniques par branche. Si vous supprimez un aperçu puis en recréez un pour la même branche, Mintlify peut émettre une nouvelle URL. +Mintlify génère automatiquement les URL d'aperçu. Le sous-domaine et le domaine ne sont pas configurables, et les domaines personnalisés sont réservés à votre déploiement en production. +
## Dépannage des déploiements de prévisualisation
diff --git a/zh/agent/index.mdx b/zh/agent/index.mdx index d08234800..f03b22f56 100644 --- a/zh/agent/index.mdx +++ b/zh/agent/index.mdx @@ -18,6 +18,17 @@ agent 是一款 AI 工具，会根据你的提示，为文档创建包含建议 所有更改都会通过拉取请求完成。agent 永远不会直接向你的主 branch 进行提交。 +
+ ## 发送你的第一个请求 +
+ +1. 前往控制台中的 [Agent](https://app.mintlify.com/products/agent) 页面，打开 agent 面板。 +2. 在消息输入框中描述你希望 agent 更改或撰写的内容。 +3. 发送消息。agent 开始工作，并在面板内评论进度。 +4. 当 agent 完成后，审阅它针对你的文档仓库打开的拉取请求。 + +你也可以从 [Slack](/zh/agent/slack)、[自动化](/zh/automations/index) 或通过 [Create agent job API](/zh/api/agent/v2/create-agent-job) 触发 agent。 +
## 你可以用智能助手做什么
diff --git a/zh/api/introduction.mdx b/zh/api/introduction.mdx index d71165ef1..2f3986418 100644 --- a/zh/api/introduction.mdx +++ b/zh/api/introduction.mdx @@ -45,13 +45,25 @@ Mintlify 的 REST（Representational State Transfer）API 让你可以以编程 ## 基础 URL
-所有 Mintlify REST API 端点均由以下地址提供服务： +所有 Mintlify REST API 请求都使用以下基础 URL： ``` https://api.mintlify.com ``` -每个端点的参考页面都会列出要调用的完整路径和 HTTP 方法。 +
+ ## 发起请求 +
+ +在 `Authorization` 请求头中以 bearer token 的形式传入你的 API key，以对每个请求进行认证。例如： + +```bash +curl https://api.mintlify.com/v1/project/update/{projectId} \ + -H "Authorization: Bearer mint_YOUR_ADMIN_API_KEY" \ + -H "Content-Type: application/json" +``` + +对于部署、agent 和 analytics 端点，请使用[管理员 API key](#admin-api-key)；对于 assistant 端点，请使用 [assistant API key](#assistant-api-key)。有关完整路径、请求体和响应结构，请参见每个端点的参考页面。
## 认证 diff --git a/zh/deploy/authentication-setup.mdx b/zh/deploy/authentication-setup.mdx index 0d3cfc69e..626bc5914 100644 --- a/zh/deploy/authentication-setup.mdx +++ b/zh/deploy/authentication-setup.mdx @@ -18,6 +18,19 @@ keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password', 'private'] 认证仅适用于托管在自定义域名或 Mintlify 子域名上的站点。例如，`docs.example.com` 或 `example.mintlify.site`。使用[自定义子路径](/zh/deploy/docs-subpath)的站点**不支持**认证。例如，`example.com/docs`。 +
+ ## 选择认证方式 +
+ +使用下方对比表来选择适合你使用场景的认证方式。请参见[功能可用性](#feature-availability) 了解每种方式如何与其他 Mintlify 功能协同工作。 + +| 方式 | 适用场景 | 方案 | 基于用户组的访问控制 | API 操作台预填 | 个性化 | +| :--- | :--- | :--- | :---: | :---: | :---: | +| Password | 简单的共享访问，无需按用户跟踪 | Pro 或 Enterprise | — | — | — | +| Private authentication | 面向 Mintlify 组织成员的内部文档 | 所有方案 | — | — | — | +| OAuth 2.0 | 已有身份提供方或 SSO，且需要按用户会话 | Enterprise | ✓ | ✓ | ✓ | +| JWT | 自定义认证后端或嵌入在自有登录后的文档 | Enterprise | ✓ | ✓ | ✓ | +
## 配置认证
diff --git a/zh/deploy/export.mdx b/zh/deploy/export.mdx index 84cc7ff35..0ab7b06ed 100644 --- a/zh/deploy/export.mdx +++ b/zh/deploy/export.mdx @@ -51,6 +51,16 @@ mint export --output customer-docs.zip --groups enterprise 导出仅包含导航中列出的页面。[隐藏页面](/zh/organize/hidden-pages) 不会包含在归档中。 +
+ ### 安全注意事项 +
+ +导出的归档是一个静态、无需认证的压缩包。任何持有该 zip 文件的人都可以查看其中包含的每个页面。 + +- `--groups` 标志用于控制在导出时 Mintlify 将哪些受用户组限制的页面包含到归档中。它**不会**在导出后强制执行认证。 +- 只与被允许查看归档内容的收件人分享归档文件。 +- 若要发布新的更改，请重新生成并重新分发归档—使用旧 zip 的收件人将继续看到旧的内容。 +
## zip 中的内容
diff --git a/zh/deploy/preview-deployments.mdx b/zh/deploy/preview-deployments.mdx index 41ccc6ed8..cb0363d54 100644 --- a/zh/deploy/preview-deployments.mdx +++ b/zh/deploy/preview-deployments.mdx @@ -134,6 +134,8 @@ keywords: ["preview URLs", "pull request previews", "branch previews", "staging 预览 URL 按 branch 唯一。如果你删除了某个预览，之后又为同一 branch 重新创建预览，Mintlify 可能会分配一个新的 URL。 +Mintlify 会自动生成预览 URL。子域名和域名不可配置，自定义域名仅保留用于你的生产部署。 +
## 预览部署故障排查
From 6ff22204f7079dce575994f9f32137a4c188e76d Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 7 Jul 2026 13:09:20 -0700 Subject: [PATCH 03/10] Apply suggestion from @ethanpalm --- deploy/preview-deployments.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index c7668c152..d54ac2ac4 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -111,7 +111,7 @@ Preview deployments stay live as long as their source branch exists in your repo Preview URLs are unique per branch. If you delete a preview and later recreate one for the same branch, Mintlify may issue a new URL. -Mintlify generates preview URLs automatically. The subdomain and domain are not configurable, and custom domains are reserved for your production deployment. +Mintlify generates preview URLs automatically. The subdomain and domain are not configurable, and custom domains only apply to your production deployment. ## Troubleshooting preview deployments From fecf67ed83d63829f99643f8f909c3bce277b048 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 7 Jul 2026 13:11:11 -0700 Subject: [PATCH 04/10] Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --- deploy/export.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/deploy/export.mdx b/deploy/export.mdx index 312b1047e..f8d8933ea 100644 --- a/deploy/export.mdx +++ b/deploy/export.mdx @@ -49,9 +49,9 @@ mint export --output customer-docs.zip --groups enterprise The exported archive is a static, unauthenticated bundle. Anyone with the zip file can view every page it contains. -- The `--groups` flag controls which group-restricted pages Mintlify includes in the archive at export time. It does **not** enforce authentication after export. +- The `--groups` flag controls which group-restricted pages Mintlify includes in the archive at export time. It does not enforce authentication after export. - Only share archives with recipients who are allowed to see the content they contain. -- Regenerate and redistribute the archive to publish new changes—recipients running an older zip continue to see the older content. +- Regenerate and redistribute the archive to publish new changes. Anyone running an older zip continues to see the older content. ## What's in the zip From 9d0704f0be78b92e233fc6311f6084df2f8906ab Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 7 Jul 2026 13:13:08 -0700 Subject: [PATCH 05/10] Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --- deploy/authentication-setup.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/deploy/authentication-setup.mdx b/deploy/authentication-setup.mdx index 7cf7ec2b9..19ce0787a 100644 --- a/deploy/authentication-setup.mdx +++ b/deploy/authentication-setup.mdx @@ -24,10 +24,10 @@ Use this comparison to pick the method that fits your use case. See [Feature ava | Method | Best for | Plan | Group-based access | API playground pre-fill | Personalization | | :--- | :--- | :--- | :---: | :---: | :---: | -| Password | Simple shared access with no per-user tracking | Pro or Enterprise | — | — | — | -| Private authentication | Internal docs for members of your Mintlify organization | All plans | — | — | — | -| OAuth 2.0 | Existing identity provider or SSO with per-user sessions | Enterprise | ✓ | ✓ | ✓ | -| JWT | Custom auth backend or embedded docs behind your own login | Enterprise | ✓ | ✓ | ✓ | +| Password | Simple shared access with no per-user tracking | Pro or Enterprise | No | No | No | +| Private authentication | Internal site for members of your Mintlify organization | All plans | No | No | No | +| OAuth 2.0 | Existing identity provider or SSO with per-user sessions | Enterprise | Yes | Yes | Yes | +| JWT | Custom auth backend or embedded content behind your own login | Enterprise | Yes | Yes | Yes | ## Configure authentication From e5962336b720fd3991fd133d0515213f319959a6 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 7 Jul 2026 13:14:12 -0700 Subject: [PATCH 06/10] Apply suggestion from @ethanpalm --- api/introduction.mdx | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/api/introduction.mdx b/api/introduction.mdx index 245899e54..e27b57833 100644 --- a/api/introduction.mdx +++ b/api/introduction.mdx @@ -41,26 +41,6 @@ The Mintlify REST (Representational State Transfer) API enables you to programma - **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). -## Base URL - -All Mintlify REST API requests use the following base URL: - -``` -https://api.mintlify.com -``` - -## Making a request - -Authenticate every request by passing your API key in the `Authorization` header as a bearer token. For example: - -```bash -curl https://api.mintlify.com/v1/project/update/{projectId} \ - -H "Authorization: Bearer mint_YOUR_ADMIN_API_KEY" \ - -H "Content-Type: application/json" -``` - -Use the [admin API key](#admin-api-key) for deployment, agent, and analytics endpoints and the [assistant API key](#assistant-api-key) for assistant endpoints. See each endpoint's reference page for its full path, request body, and response schema. - ## Authentication Generate API keys on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Each API key belongs to an organization--you can use keys across multiple deployments within the same organization. From 2c4908155b039802febfbc7bdf60b2399c3e7f16 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 7 Jul 2026 13:14:59 -0700 Subject: [PATCH 07/10] Apply suggestion from @ethanpalm --- agent/index.mdx | 9 --------- 1 file changed, 9 deletions(-) diff --git a/agent/index.mdx b/agent/index.mdx index 3d103554b..195bf5c4d 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -20,15 +20,6 @@ The agent is an AI tool that creates pull requests with proposed changes to your All changes go through pull requests. The agent never commits directly to your main branch. -## Send your first request - -1. Go to the [Agent](https://app.mintlify.com/products/agent) page in your dashboard to open the agent panel. -2. Describe what you want the agent to change or write in the message field. -3. Send the message. The agent starts working and comments on progress inside the panel. -4. When the agent finishes, review the pull request it opens against your docs repository. - -You can also trigger the agent from [Slack](/agent/slack), from [automations](/automations/index), or through the [Create agent job API](/api/agent/v2/create-agent-job). - ## What you can do with the agent Use the agent to: From 36e5d28f29666f927b1db5c9f4069c08bb468a81 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 7 Jul 2026 13:15:49 -0700 Subject: [PATCH 08/10] Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --- es/agent/index.mdx | 11 ----------- es/api/introduction.mdx | 13 ------------- 2 files changed, 24 deletions(-) diff --git a/es/agent/index.mdx b/es/agent/index.mdx index dd83b2832..d65d7f5f0 100644 --- a/es/agent/index.mdx +++ b/es/agent/index.mdx @@ -18,17 +18,6 @@ El agente es una herramienta de IA que crea solicitudes de extracción (pull req Todos los cambios pasan por solicitudes de extracción (pull requests). El agente nunca realiza confirmaciones directamente en tu branch principal. -
- ## Envía tu primera solicitud -
- -1. Ve a la página [Agent](https://app.mintlify.com/products/agent) en tu dashboard para abrir el panel del agente. -2. Describe lo que quieres que el agente cambie o escriba en el campo del mensaje. -3. Envía el mensaje. El agente comienza a trabajar y comenta el progreso dentro del panel. -4. Cuando el agente termine, revisa la solicitud de extracción (pull request) que abre en el repositorio de tu documentación. - -También puedes activar el agente desde [Slack](/es/agent/slack), desde [automatizaciones](/es/automations/index) o mediante la [API para crear una tarea de agente](/es/api/agent/v2/create-agent-job). -
## Qué puedes hacer con el agente
diff --git a/es/api/introduction.mdx b/es/api/introduction.mdx index 9fe92d110..f7339d44d 100644 --- a/es/api/introduction.mdx +++ b/es/api/introduction.mdx @@ -51,19 +51,6 @@ Todas las solicitudes a la API REST de Mintlify usan la siguiente URL base: https://api.mintlify.com ``` -
- ## Hacer una solicitud -
- -Autentica cada solicitud pasando tu API key en el encabezado `Authorization` como un bearer token. Por ejemplo: - -```bash -curl https://api.mintlify.com/v1/project/update/{projectId} \ - -H "Authorization: Bearer mint_YOUR_ADMIN_API_KEY" \ - -H "Content-Type: application/json" -``` - -Usa la [clave de la API de administrador](#admin-api-key) para los endpoints de implementación, agente y analítica, y la [key del Assistant API](#assistant-api-key) para los endpoints del assistant. Consulta la página de referencia de cada endpoint para conocer su ruta completa, el cuerpo de la solicitud y el esquema de respuesta.
## Autenticación From 037a54b4b118ad771e7acc0d493b435ae6ec4f93 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 7 Jul 2026 13:16:55 -0700 Subject: [PATCH 09/10] Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --- fr/agent/index.mdx | 11 ----------- fr/api/introduction.mdx | 13 ------------- 2 files changed, 24 deletions(-) diff --git a/fr/agent/index.mdx b/fr/agent/index.mdx index d892e8625..a45a17211 100644 --- a/fr/agent/index.mdx +++ b/fr/agent/index.mdx @@ -18,17 +18,6 @@ L'agent est un outil d'IA qui crée des pull requests (demandes de fusion) avec Tous les changements passent par des pull requests (demandes de fusion). L'agent ne fait jamais de commit directement sur votre branche principale. -
- ## Envoyer votre première requête -
- -1. Accédez à la page [Agent](https://app.mintlify.com/products/agent) dans votre Dashboard pour ouvrir le panneau de l'agent. -2. Décrivez ce que vous souhaitez que l'agent modifie ou rédige dans le champ de message. -3. Envoyez le message. L'agent se met au travail et commente sa progression dans le panneau. -4. Une fois l'agent terminé, examinez la pull request (demande de fusion) qu'il ouvre sur le dépôt de votre documentation. - -Vous pouvez également déclencher l'agent depuis [Slack](/fr/agent/slack), depuis les [automatisations](/fr/automations/index) ou via l'[API Create agent job](/fr/api/agent/v2/create-agent-job). -
## Ce que vous pouvez faire avec l’agent
diff --git a/fr/api/introduction.mdx b/fr/api/introduction.mdx index 87039f49b..dce160103 100644 --- a/fr/api/introduction.mdx +++ b/fr/api/introduction.mdx @@ -51,19 +51,6 @@ Toutes les requêtes vers l'API REST Mintlify utilisent l'URL de base suivante : https://api.mintlify.com ``` -
- ## Effectuer une requête -
- -Authentifiez chaque requête en transmettant votre clé d'API dans l'en-tête `Authorization` sous forme de jeton bearer. Par exemple : - -```bash -curl https://api.mintlify.com/v1/project/update/{projectId} \ - -H "Authorization: Bearer mint_YOUR_ADMIN_API_KEY" \ - -H "Content-Type: application/json" -``` - -Utilisez la [clé d'API administrateur](#admin-api-key) pour les endpoints de déploiement, d'agent et d'analytique, et la [clé d'API de l'Assistant](#assistant-api-key) pour les endpoints de l'Assistant. Consultez la page de référence de chaque endpoint pour connaître son chemin complet, le corps de la requête et le schéma de la réponse.
## Authentification From 631193595ae6d5c73793c7a27b4083321f797b74 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 7 Jul 2026 13:17:35 -0700 Subject: [PATCH 10/10] Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --- zh/agent/index.mdx | 11 ----------- zh/api/introduction.mdx | 13 ------------- 2 files changed, 24 deletions(-) diff --git a/zh/agent/index.mdx b/zh/agent/index.mdx index f03b22f56..d08234800 100644 --- a/zh/agent/index.mdx +++ b/zh/agent/index.mdx @@ -18,17 +18,6 @@ agent 是一款 AI 工具，会根据你的提示，为文档创建包含建议 所有更改都会通过拉取请求完成。agent 永远不会直接向你的主 branch 进行提交。 -
- ## 发送你的第一个请求 -
- -1. 前往控制台中的 [Agent](https://app.mintlify.com/products/agent) 页面，打开 agent 面板。 -2. 在消息输入框中描述你希望 agent 更改或撰写的内容。 -3. 发送消息。agent 开始工作，并在面板内评论进度。 -4. 当 agent 完成后，审阅它针对你的文档仓库打开的拉取请求。 - -你也可以从 [Slack](/zh/agent/slack)、[自动化](/zh/automations/index) 或通过 [Create agent job API](/zh/api/agent/v2/create-agent-job) 触发 agent。 -
## 你可以用智能助手做什么
diff --git a/zh/api/introduction.mdx b/zh/api/introduction.mdx index 2f3986418..cc1bd34b3 100644 --- a/zh/api/introduction.mdx +++ b/zh/api/introduction.mdx @@ -51,19 +51,6 @@ Mintlify 的 REST（Representational State Transfer）API 让你可以以编程 https://api.mintlify.com ``` -
- ## 发起请求 -
- -在 `Authorization` 请求头中以 bearer token 的形式传入你的 API key，以对每个请求进行认证。例如： - -```bash -curl https://api.mintlify.com/v1/project/update/{projectId} \ - -H "Authorization: Bearer mint_YOUR_ADMIN_API_KEY" \ - -H "Content-Type: application/json" -``` - -对于部署、agent 和 analytics 端点，请使用[管理员 API key](#admin-api-key)；对于 assistant 端点，请使用 [assistant API key](#assistant-api-key)。有关完整路径、请求体和响应结构，请参见每个端点的参考页面。
## 认证