From 7e07b3d648973e15afe837b54c921ba0632ba698 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 1 Apr 2026 00:59:59 +0000 Subject: [PATCH] Translate get page content endpoint to es, fr, zh Generated-By: mintlify-agent --- docs.json | 9 ++-- es/api/assistant/get-page-content.mdx | 6 +++ es/api/introduction.mdx | 5 +- es/discovery-openapi.json | 74 +++++++++++++++++++++++++++ fr/api/assistant/get-page-content.mdx | 6 +++ fr/api/introduction.mdx | 5 +- fr/discovery-openapi.json | 74 +++++++++++++++++++++++++++ zh/api/assistant/get-page-content.mdx | 6 +++ zh/api/introduction.mdx | 5 +- zh/discovery-openapi.json | 74 +++++++++++++++++++++++++++ 10 files changed, 255 insertions(+), 9 deletions(-) create mode 100644 es/api/assistant/get-page-content.mdx create mode 100644 fr/api/assistant/get-page-content.mdx create mode 100644 zh/api/assistant/get-page-content.mdx diff --git a/docs.json b/docs.json index 339d661cb..5c863c53e 100644 --- a/docs.json +++ b/docs.json @@ -742,7 +742,8 @@ "icon": "bot-message-square", "pages": [ "fr/api/assistant/create-assistant-message-v2", - "fr/api/assistant/search" + "fr/api/assistant/search", + "fr/api/assistant/get-page-content" ] }, { @@ -1114,7 +1115,8 @@ "icon": "bot-message-square", "pages": [ "es/api/assistant/create-assistant-message-v2", - "es/api/assistant/search" + "es/api/assistant/search", + "es/api/assistant/get-page-content" ] }, { @@ -1486,7 +1488,8 @@ "icon": "bot-message-square", "pages": [ "zh/api/assistant/create-assistant-message-v2", - "zh/api/assistant/search" + "zh/api/assistant/search", + "zh/api/assistant/get-page-content" ] }, { diff --git a/es/api/assistant/get-page-content.mdx b/es/api/assistant/get-page-content.mdx new file mode 100644 index 000000000..273839343 --- /dev/null +++ b/es/api/assistant/get-page-content.mdx @@ -0,0 +1,6 @@ +--- +title: "Obtener contenido de la página" +description: "Recupera el contenido de texto completo de una página de documentación por su ruta." +openapi: "/es/discovery-openapi.json POST /v1/page/{domain}" +keywords: [ "página", "contenido", "recuperar" ] +--- diff --git a/es/api/introduction.mdx b/es/api/introduction.mdx index 08c5d5acc..edabcf184 100644 --- a/es/api/introduction.mdx +++ b/es/api/introduction.mdx @@ -17,6 +17,7 @@ La REST (Representational State Transfer) API de Mintlify te permite interactuar * [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 page content](/es/api/assistant/get-page-content): Recupera el contenido de texto completo de una página de 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,7 +27,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). -* **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). +* **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). @@ -52,7 +53,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 [Create assistant message](/es/api/assistant/create-assistant-message-v2) 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), [Search documentation](/es/api/assistant/search) y [Get page content](/es/api/assistant/get-page-content). Las keys del Assistant API comienzan con el prefijo `mint_dsc_`. diff --git a/es/discovery-openapi.json b/es/discovery-openapi.json index c5cf1e1f1..fb444c0c4 100644 --- a/es/discovery-openapi.json +++ b/es/discovery-openapi.json @@ -740,6 +740,80 @@ } } }, + "/v1/page/{domain}": { + "post": { + "summary": "Obtener contenido de la página", + "description": "Recupera el contenido de texto completo de una página de documentación específica por su ruta. Úsalo después de una búsqueda para obtener el contenido completo de una página coincidente.", + "parameters": [ + { + "name": "domain", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "El identificador domain de tu URL `domain.mintlify.app`. Se encuentra al final de la URL de tu dashboard. Por ejemplo, `dashboard.mintlify.com/organization/domain` tiene un identificador domain de `domain`." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "page" + ], + "properties": { + "page": { + "type": "string", + "description": "El slug o ruta de la página cuyo contenido se desea recuperar. Corresponde al campo `page` devuelto por el endpoint [Search documentation](/es/api/assistant/search)." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Contenido de la página recuperado exitosamente", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "La ruta de la página solicitada." + }, + "content": { + "type": "string", + "description": "El contenido de texto completo de la página." + } + } + } + } + } + }, + "404": { + "description": "Página no encontrada o índice de búsqueda no disponible", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Mensaje de error que describe por qué no se pudo encontrar la página." + } + } + } + } + } + } + } + } + }, "/v1/search/{domain}": { "post": { "x-mint": { diff --git a/fr/api/assistant/get-page-content.mdx b/fr/api/assistant/get-page-content.mdx new file mode 100644 index 000000000..3f2985918 --- /dev/null +++ b/fr/api/assistant/get-page-content.mdx @@ -0,0 +1,6 @@ +--- +title: "Obtenir le contenu de la page" +description: "Récupérez le contenu textuel complet d'une page de documentation par son chemin." +openapi: "/fr/discovery-openapi.json POST /v1/page/{domain}" +keywords: [ "page", "contenu", "récupérer" ] +--- diff --git a/fr/api/introduction.mdx b/fr/api/introduction.mdx index b872d5cff..ab4b9d3cb 100644 --- a/fr/api/introduction.mdx +++ b/fr/api/introduction.mdx @@ -17,6 +17,7 @@ L'API REST (Representational State Transfer) de Mintlify vous permet d'interagir * [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 page content](/fr/api/assistant/get-page-content): Récupérez le contenu textuel complet d'une page de 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. @@ -26,7 +27,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). -* **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). +* **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). @@ -52,7 +53,7 @@ La clé d'API administrateur est un secret côté serveur. Ne l'exposez pas dans ### Clé d'API de l'Assistant -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). +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), [Search documentation](/fr/api/assistant/search) et [Get page content](/fr/api/assistant/get-page-content). Les clés d'API de l'Assistant commencent par le préfixe `mint_dsc_`. diff --git a/fr/discovery-openapi.json b/fr/discovery-openapi.json index d7eb00747..a52e57a97 100644 --- a/fr/discovery-openapi.json +++ b/fr/discovery-openapi.json @@ -740,6 +740,80 @@ } } }, + "/v1/page/{domain}": { + "post": { + "summary": "Obtenir le contenu de la page", + "description": "Récupérez le contenu textuel complet d'une page de documentation spécifique par son chemin. Utilisez-le après une recherche pour obtenir le contenu complet d'une page correspondante.", + "parameters": [ + { + "name": "domain", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "L'identifiant domain de votre URL `domain.mintlify.app`. Il se trouve à la fin de l'URL de votre Dashboard. Par exemple, `dashboard.mintlify.com/organization/domain` a un identifiant domain de `domain`." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "page" + ], + "properties": { + "page": { + "type": "string", + "description": "Le slug ou chemin de la page dont le contenu doit être récupéré. Cela correspond au champ `page` renvoyé par l'endpoint [Search documentation](/fr/api/assistant/search)." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Contenu de la page récupéré avec succès", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "Le chemin de la page demandée." + }, + "content": { + "type": "string", + "description": "Le contenu textuel complet de la page." + } + } + } + } + } + }, + "404": { + "description": "Page non trouvée ou index de recherche non disponible", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Message d'erreur décrivant pourquoi la page n'a pas pu être trouvée." + } + } + } + } + } + } + } + } + }, "/v1/search/{domain}": { "post": { "x-mint": { diff --git a/zh/api/assistant/get-page-content.mdx b/zh/api/assistant/get-page-content.mdx new file mode 100644 index 000000000..1e820fea3 --- /dev/null +++ b/zh/api/assistant/get-page-content.mdx @@ -0,0 +1,6 @@ +--- +title: "获取页面内容" +description: "通过路径检索文档页面的完整文本内容。" +openapi: "/zh/discovery-openapi.json POST /v1/page/{domain}" +keywords: [ "页面", "内容", "检索" ] +--- diff --git a/zh/api/introduction.mdx b/zh/api/introduction.mdx index b1844beb4..ba44b829e 100644 --- a/zh/api/introduction.mdx +++ b/zh/api/introduction.mdx @@ -17,6 +17,7 @@ Mintlify 的 REST（Representational State Transfer）API 让你可以以编程 * [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/assistant/get-page-content)：检索文档页面的完整文本内容。 * [获取用户反馈](/zh/api/analytics/feedback)：从您的文档中导出用户反馈。 * [获取 AI 助手会话](/zh/api/analytics/assistant-conversations)：导出 AI 助手的会话历史。 @@ -26,7 +27,7 @@ Mintlify 的 REST（Representational State Transfer）API 让你可以以编程 * **自动化部署**：使用 [Trigger update](/zh/api/update/trigger) 和 [Get update status](/zh/api/update/status)，在设定的时间间隔或当特定事件发生时触发站点更新。 * **CI/CD 集成**：在代码变更时，将文档更新作为部署流水线的一部分来执行，使用 [Trigger update](/zh/api/update/trigger)。 -* **自定义集成**：使用 [Create assistant message](/zh/api/assistant/create-assistant-message-v2) 和 [Search documentation](/zh/api/assistant/search)，将 AI 助手嵌入到你的产品、支持门户或内部工具中。 +* **自定义集成**：使用 [Create assistant message](/zh/api/assistant/create-assistant-message-v2)、[Search documentation](/zh/api/assistant/search) 和 [Get page content](/zh/api/assistant/get-page-content)，将 AI 助手嵌入到你的产品、支持门户或内部工具中。 * **自动化编辑**：使用 agent 任务，以编程方式大规模更新文档，配合 [Create agent job](/zh/api/agent/v2/create-agent-job)、[Get agent job](/zh/api/agent/v2/get-agent-job) 和 [Send follow-up message](/zh/api/agent/v2/send-message)。 * **Analytics 导出**：使用 [Get user feedback](/zh/api/analytics/feedback) 和 [Get assistant conversations](/zh/api/analytics/assistant-conversations)，导出反馈和 AI 助手会话以进行外部分析。 @@ -52,7 +53,7 @@ Mintlify 的 REST（Representational State Transfer）API 让你可以以编程 ### Assistant API key -使用 assistant API key 对发往 [Create assistant message](/zh/api/assistant/create-assistant-message-v2) 和 [Search documentation](/zh/api/assistant/search) 端点的请求进行认证。 +使用 assistant API key 对发往 [Create assistant message](/zh/api/assistant/create-assistant-message-v2)、[Search documentation](/zh/api/assistant/search) 和 [Get page content](/zh/api/assistant/get-page-content) 端点的请求进行认证。 assistant API key 以 `mint_dsc_` 前缀开头。 diff --git a/zh/discovery-openapi.json b/zh/discovery-openapi.json index 98ed67c78..b5d3a25a7 100644 --- a/zh/discovery-openapi.json +++ b/zh/discovery-openapi.json @@ -740,6 +740,80 @@ } } }, + "/v1/page/{domain}": { + "post": { + "summary": "获取页面内容", + "description": "通过路径检索特定文档页面的完整文本内容。在搜索之后使用此接口来获取匹配页面的完整内容。", + "parameters": [ + { + "name": "domain", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "来自你的 `domain.mintlify.app` URL 的域名标识符。可以在你的控制台 URL 末尾找到。例如，`dashboard.mintlify.com/organization/domain` 的域名标识符为 `domain`。" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "page" + ], + "properties": { + "page": { + "type": "string", + "description": "要检索内容的页面路径或 slug。对应于 [Search documentation](/zh/api/assistant/search) 端点返回的 `page` 字段。" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "页面内容检索成功", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "所请求的页面路径。" + }, + "content": { + "type": "string", + "description": "页面的完整文本内容。" + } + } + } + } + } + }, + "404": { + "description": "页面未找到或搜索索引不可用", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "描述为何无法找到该页面的错误消息。" + } + } + } + } + } + } + } + } + }, "/v1/search/{domain}": { "post": { "x-mint": {