From 76364cb09160b0c7c5d65488f4914751ac2ce693 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 17 Mar 2026 18:37:39 +0000 Subject: [PATCH] Translate v2 API endpoint updates and groups field to es, fr, zh Generated-By: mintlify-agent --- es/api/introduction.mdx | 18 +++++++------- es/organize/pages.mdx | 6 ++++- fr/api/introduction.mdx | 52 ++++++++++++++++++++--------------------- fr/organize/pages.mdx | 6 ++++- zh/api/introduction.mdx | 22 ++++++++--------- zh/organize/pages.mdx | 6 ++++- 6 files changed, 61 insertions(+), 49 deletions(-) diff --git a/es/api/introduction.mdx b/es/api/introduction.mdx index bacb87100..395856a2e 100644 --- a/es/api/introduction.mdx +++ b/es/api/introduction.mdx @@ -12,10 +12,10 @@ La REST API de Mintlify te permite interactuar de forma programática con tu doc * [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. -* [Create agent job](/es/api/agent/create-agent-job): Crea una tarea de agente para editar tu documentación automáticamente. -* [Get agent job](/es/api/agent/get-agent-job): Obtén los detalles y el estado de una tarea de agente específica. -* [Get all agent jobs](/es/api/agent/get-all-jobs): Obtén todas las tareas de agente para un domain. -* [Generate assistant message](/es/api/assistant/create-assistant-message): Integra el assistant, entrenado con tu documentación, en cualquier aplicación que elijas. +* [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. +* [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 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. @@ -26,8 +26,8 @@ La REST API de Mintlify te permite interactuar de forma programática con tu doc * **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). -* **Integraciones personalizadas**: Inserta el Asistente de IA en tu producto, portal de soporte o herramientas internas con [Generate assistant message](/es/api/assistant/create-assistant-message) y [Search documentation](/es/api/assistant/search). -* **Edición automatizada**: Usa trabajos de agente para actualizar la documentación programáticamente y a escala con [Create agent job](/es/api/agent/create-agent-job), [Get agent job](/es/api/agent/get-agent-job) y [Get all agent jobs](/es/api/agent/get-all-jobs). +* **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) y [Search documentation](/es/api/assistant/search). +* **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).
@@ -42,7 +42,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 [Activar actualización](/es/api/update/trigger), [Obtener estado de la actualización](/es/api/update/status), [Crear tarea de agente](/es/api/agent/create-agent-job), [Obtener tarea de agente](/es/api/agent/get-agent-job), [Obtener todas las tareas de agente](/es/api/agent/get-all-jobs), [Obtener comentarios de los usuarios](/es/api/analytics/feedback) y [Obtener conversaciones del assistant](/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 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_`. @@ -52,7 +52,7 @@ La clave de la API de administrador es un secreto del lado del servidor. No la e ### key del Assistant API -Usa la key del Assistant API para autenticar solicitudes a los endpoints [Generate assistant message](/es/api/assistant/create-assistant-message) y [Search documentation](/es/api/assistant/search). +Usa la key del Assistant API para autenticar solicitudes a los endpoints [Create assistant message](/es/api/assistant/create-assistant-message-v2) y [Search documentation](/es/api/assistant/search). Las keys del Assistant API comienzan con el prefijo `mint_dsc_`. @@ -60,4 +60,4 @@ La key del Assistant API es un token público que puede referenciarse en tu cód Las llamadas que usan el token del Assistant API pueden generar costos: ya sea usando tus créditos del assistant o incurriendo en excedentes. - \ No newline at end of file + diff --git a/es/organize/pages.mdx b/es/organize/pages.mdx index c9bb3a2d0..5f1eec1bc 100644 --- a/es/organize/pages.mdx +++ b/es/organize/pages.mdx @@ -65,7 +65,11 @@ Usa el frontmatter para controlar: - Establécelo en `true` para mostrar una etiqueta "en desuso" junto al título de la página. Úsalo para marcar contenido desactualizado o funciones heredadas sin dejar de mantener la página accesible. + Establécelo en `true` para mostrar una etiqueta "en desuso" junto al título de la página. Úsalo para marcar contenido desactualizado o funciones heredadas sin dejar de mantener la página accesible. + + + + Restringe la página a usuarios en grupos específicos. Los usuarios deben pertenecer a al menos uno de los grupos listados para acceder a la página. Se debe configurar la [autenticación](/es/deploy/authentication-setup). Consulta [Controlar el acceso con grupos](/es/deploy/authentication-setup#control-access-with-groups) para más información. diff --git a/fr/api/introduction.mdx b/fr/api/introduction.mdx index 60f5479c3..bc658d097 100644 --- a/fr/api/introduction.mdx +++ b/fr/api/introduction.mdx @@ -1,63 +1,63 @@ --- title: "Introduction" -description: "Déclenchez des mises à jour, intégrez l’Assistant IA, exportez les données d’analyse, et plus encore" +description: "Déclenchez des mises à jour, intégrez l'Assistant IA, exportez les données d'analyse, et plus encore" keywords: ["REST API", "endpoints", "API keys"] --- -L’API REST de Mintlify vous permet d’interagir programmatiquement avec votre documentation, de déclencher des mises à jour, d’intégrer des expériences de chat propulsées par l’IA et d’exporter les données d’analyse. +L'API REST de Mintlify vous permet d'interagir programmatiquement avec votre documentation, de déclencher des mises à jour, d'intégrer des expériences de chat propulsées par l'IA et d'exporter les données d'analyse.
## Endpoints
* [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. -* [Create agent job](/fr/api/agent/create-agent-job): Créez une tâche d’agent pour modifier automatiquement votre documentation. -* [Get agent job](/fr/api/agent/get-agent-job): Récupérez les détails et le statut d’une tâche d’agent spécifique. -* [Get all agent jobs](/fr/api/agent/get-all-jobs): Récupérez toutes les tâches d’agent pour un domain. -* [Generate assistant message](/fr/api/assistant/create-assistant-message): Intégrez l’Assistant, entraîné sur votre documentation, dans n’importe quelle application de votre choix. +* [Get update status](/fr/api/update/status): Récupérez le statut d'une mise à jour et d'autres détails sur votre documentation. +* [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. +* [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 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. +* [Get assistant conversations](/fr/api/analytics/assistant-conversations): Exportez l'historique des conversations de l'Assistant IA.
- ### Cas d’utilisation courants + ### Cas d'utilisation courants
-* **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). -* **Intégrations personnalisées** : Intégrez l’Assistant IA à votre produit, portail d’assistance ou outils internes avec [Generate assistant message](/fr/api/assistant/create-assistant-message) et [Search documentation](/fr/api/assistant/search). -* **É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/create-agent-job), [Get agent job](/fr/api/agent/get-agent-job), et [Get all agent jobs](/fr/api/agent/get-all-jobs). -* **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). +* **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). +* **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) et [Search documentation](/fr/api/assistant/search). +* **É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).
## Authentification
-Générez des clés d’API depuis la [page API keys](https://dashboard.mintlify.com/settings/organization/api-keys) de votre Dashboard. Les clés d’API sont associées à toute l’organisation et peuvent être utilisées sur plusieurs déploiements au sein de la même organisation. +Générez des clés d'API depuis la [page API keys](https://dashboard.mintlify.com/settings/organization/api-keys) de votre Dashboard. Les clés d'API sont associées à toute l'organisation et peuvent être utilisées sur plusieurs déploiements au sein de la même organisation. -Vous pouvez créer jusqu’à 10 clés d’API par heure et par organisation. +Vous pouvez créer jusqu'à 10 clés d'API par heure et par organisation.
- ### Clé d’API administrateur + ### Clé d'API administrateur
-Utilisez la clé d’API administrateur pour authentifier les requêtes vers [déclencher une mise à jour](/fr/api/update/trigger), [obtenir l’état de la mise à jour](/fr/api/update/status), [créer une tâche d’agent](/fr/api/agent/create-agent-job), [obtenir une tâche d’agent](/fr/api/agent/get-agent-job), [obtenir toutes les tâches d’agent](/fr/api/agent/get-all-jobs), [obtenir les retours utilisateurs](/fr/api/analytics/feedback) et [obtenir les conversations de l’Assistant](/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 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_`. +Les clés d'API administrateur commencent par le préfixe `mint_`. -La clé d’API administrateur est un secret côté serveur. Ne l’exposez pas dans du code côté client. +La clé d'API administrateur est un secret côté serveur. Ne l'exposez pas dans du code côté client.
- ### Clé d’API de l’Assistant + ### Clé d'API de l'Assistant
-Utilisez la clé d’API de l’Assistant pour authentifier les requêtes vers les points de terminaison [Générer un message de l’assistant](/fr/api/assistant/create-assistant-message) et [Rechercher dans la documentation](/fr/api/assistant/search). +Utilisez la clé d'API de l'Assistant pour authentifier les requêtes vers les points de terminaison [Create assistant message](/fr/api/assistant/create-assistant-message-v2) et [Search documentation](/fr/api/assistant/search). -Les clés d’API de l’Assistant commencent par le préfixe `mint_dsc_`. +Les clés d'API de l'Assistant commencent par le préfixe `mint_dsc_`. -La clé d’API de l’Assistant est un jeton public qui peut être référencé dans votre code front-end. +La clé d'API de l'Assistant est un jeton public qui peut être référencé dans votre code front-end. - Les appels utilisant le token de l’API de l’Assistant peuvent entraîner des coûts : soit en utilisant vos crédits d’Assistant, soit en engendrant des dépassements. - \ No newline at end of file + Les appels utilisant le token de l'API de l'Assistant peuvent entraîner des coûts : soit en utilisant vos crédits d'Assistant, soit en engendrant des dépassements. + diff --git a/fr/organize/pages.mdx b/fr/organize/pages.mdx index 69c0f90f8..bbea6dbad 100644 --- a/fr/organize/pages.mdx +++ b/fr/organize/pages.mdx @@ -65,7 +65,11 @@ Utilisez le frontmatter pour contrôler : - Définir sur `true` pour afficher un libellé "obsolète" à côté du titre de la page. Utilisez ceci pour marquer du contenu obsolète ou des fonctionnalités héritées tout en gardant la page accessible. + Définir sur `true` pour afficher un libellé "obsolète" à côté du titre de la page. Utilisez ceci pour marquer du contenu obsolète ou des fonctionnalités héritées tout en gardant la page accessible. + + + + Restreint la page aux utilisateurs appartenant à des groupes spécifiques. Les utilisateurs doivent appartenir à au moins un des groupes listés pour accéder à la page. L'[authentification](/fr/deploy/authentication-setup) doit être configurée. Voir [Contrôler l'accès avec des groupes](/fr/deploy/authentication-setup#control-access-with-groups) pour plus d'informations. diff --git a/zh/api/introduction.mdx b/zh/api/introduction.mdx index b39537504..9e9f6b990 100644 --- a/zh/api/introduction.mdx +++ b/zh/api/introduction.mdx @@ -10,12 +10,12 @@ Mintlify 的 REST API 让你可以以编程方式与文档交互、触发更新 ## 端点 -* [触发更新](/zh/api/update/trigger)：在需要时触发您站点的更新。 -* [获取更新状态](/zh/api/update/status)：获取某次更新的状态以及与您的文档相关的其他详细信息。 -* [创建代理任务](/zh/api/agent/create-agent-job)：创建一个代理任务以自动编辑您的文档。 -* [获取代理任务](/zh/api/agent/get-agent-job)：获取特定代理任务的详细信息和状态。 -* [获取所有代理任务](/zh/api/agent/get-all-jobs)：获取某个 domain 下的所有代理任务。 -* [生成 AI 助手消息](/zh/api/assistant/create-assistant-message)：将基于您的文档训练的 AI 助手嵌入到任意您选择的应用中。 +* [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)：向已有的代理任务发送后续消息。 +* [Create assistant message](/zh/api/assistant/create-assistant-message-v2)：将基于您的文档训练的 AI 助手嵌入到任意您选择的应用中。 * [搜索文档](/zh/api/assistant/search)：搜索您的文档。 * [获取用户反馈](/zh/api/analytics/feedback)：从您的文档中导出用户反馈。 * [获取 AI 助手会话](/zh/api/analytics/assistant-conversations)：导出 AI 助手的会话历史。 @@ -26,8 +26,8 @@ Mintlify 的 REST API 让你可以以编程方式与文档交互、触发更新 * **自动化部署**：使用 [Trigger update](/zh/api/update/trigger) 和 [Get update status](/zh/api/update/status)，在设定的时间间隔或当特定事件发生时触发站点更新。 * **CI/CD 集成**：在代码变更时，将文档更新作为部署流水线的一部分来执行，使用 [Trigger update](/zh/api/update/trigger)。 -* **自定义集成**：使用 [Generate assistant message](/zh/api/assistant/create-assistant-message) 和 [Search documentation](/zh/api/assistant/search)，将 AI 助手嵌入到你的产品、支持门户或内部工具中。 -* **自动化编辑**：使用 agent 任务，以编程方式大规模更新文档，配合 [Create agent job](/zh/api/agent/create-agent-job)、[Get agent job](/zh/api/agent/get-agent-job) 和 [Get all agent jobs](/zh/api/agent/get-all-jobs)。 +* **自定义集成**：使用 [Create assistant message](/zh/api/assistant/create-assistant-message-v2) 和 [Search documentation](/zh/api/assistant/search)，将 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)，导出反馈和 AI 助手会话以进行外部分析。
@@ -42,7 +42,7 @@ Mintlify 的 REST API 让你可以以编程方式与文档交互、触发更新 ### 管理员 API key
-使用管理员 API key 对发送到 [触发更新](/zh/api/update/trigger)、[获取更新状态](/zh/api/update/status)、[创建代理任务](/zh/api/agent/create-agent-job)、[获取代理任务](/zh/api/agent/get-agent-job)、[获取所有代理任务](/zh/api/agent/get-all-jobs)、[获取用户反馈](/zh/api/analytics/feedback) 和 [获取 AI 助手会话](/zh/api/analytics/assistant-conversations) 的请求进行身份验证。 +使用管理员 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) 的请求进行身份验证。 管理员 API key 以 `mint_` 前缀开头。 @@ -52,7 +52,7 @@ Mintlify 的 REST API 让你可以以编程方式与文档交互、触发更新 ### Assistant API key -使用 assistant API key 对发往 [生成助手消息](/zh/api/assistant/create-assistant-message) 和 [搜索文档](/zh/api/assistant/search) 端点的请求进行认证。 +使用 assistant API key 对发往 [Create assistant message](/zh/api/assistant/create-assistant-message-v2) 和 [Search documentation](/zh/api/assistant/search) 端点的请求进行认证。 assistant API key 以 `mint_dsc_` 前缀开头。 @@ -60,4 +60,4 @@ assistant API key 是一个公共令牌，你可以在前端代码中引用。 使用 assistant API token 进行的调用可能会产生费用：可能会消耗你的助手额度，或产生超额费用。 - \ No newline at end of file + diff --git a/zh/organize/pages.mdx b/zh/organize/pages.mdx index cbdacba72..f85940238 100644 --- a/zh/organize/pages.mdx +++ b/zh/organize/pages.mdx @@ -65,7 +65,11 @@ keywords: ["tags", "tag", "frontmatter", "metadata", "layout"] - 设为 `true` 可在页面标题旁显示“deprecated”标签。可用它标记过时内容或旧版功能，同时保持页面可访问。 + 设为 `true` 可在页面标题旁显示"deprecated"标签。可用它标记过时内容或旧版功能，同时保持页面可访问。 + + + + 将页面限制为特定组中的用户。用户必须属于至少一个列出的组才能访问该页面。必须先设置[身份验证](/zh/deploy/authentication-setup)。详情参见[使用组控制访问](/zh/deploy/authentication-setup#control-access-with-groups)。