diff --git a/api/assistant/get-page-content.mdx b/api/assistant/get-page-content.mdx new file mode 100644 index 000000000..cfce63456 --- /dev/null +++ b/api/assistant/get-page-content.mdx @@ -0,0 +1,6 @@ +--- +title: "Get page content" +description: "Retrieve the full content of a specific documentation page by its slug." +openapi: "/discovery-openapi.json POST /v1/page/{domain}" +keywords: [ "page", "content", "fetch" ] +--- diff --git a/discovery-openapi.json b/discovery-openapi.json index db982b264..74848fd81 100644 --- a/discovery-openapi.json +++ b/discovery-openapi.json @@ -840,6 +840,97 @@ } } } + }, + "/v1/page/{domain}": { + "post": { + "summary": "Get page content", + "description": "Retrieve the full content of a specific documentation page by its slug. Returns the complete stitched content from all chunks of the page.", + "parameters": [ + { + "name": "domain", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The domain identifier from your `domain.mintlify.app` URL. Can be found at the end of your dashboard URL. For example, `dashboard.mintlify.com/organization/domain` has a domain identifier of `domain`." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "page" + ], + "properties": { + "page": { + "type": "string", + "description": "The page slug or path to retrieve content for (e.g. `getting-started/quickstart`)." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Page content retrieved successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "The page slug that was requested." + }, + "content": { + "type": "string", + "description": "The full stitched content of the page." + } + } + } + } + } + }, + "400": { + "description": "Invalid request body", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "errors": { + "type": "object" + } + } + } + } + } + }, + "404": { + "description": "Page not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + } + } + } + } + } } }, "components": { diff --git a/docs.json b/docs.json index 36162ba31..868fa5890 100644 --- a/docs.json +++ b/docs.json @@ -365,7 +365,8 @@ "icon": "bot-message-square", "pages": [ "api/assistant/create-assistant-message-v2", - "api/assistant/search" + "api/assistant/search", + "api/assistant/get-page-content" ] }, { @@ -737,7 +738,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" ] }, { @@ -1109,7 +1111,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" ] }, { @@ -1481,7 +1484,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..6fbe0a85a --- /dev/null +++ b/es/api/assistant/get-page-content.mdx @@ -0,0 +1,6 @@ +--- +title: "Obtener contenido de página" +description: "Recupera el contenido completo de una página de documentación específica por su slug." +openapi: "/es/discovery-openapi.json POST /v1/page/{domain}" +keywords: [ "página", "contenido", "obtener" ] +--- diff --git a/es/discovery-openapi.json b/es/discovery-openapi.json index c5cf1e1f1..e92c5572c 100644 --- a/es/discovery-openapi.json +++ b/es/discovery-openapi.json @@ -840,6 +840,97 @@ } } } + }, + "/v1/page/{domain}": { + "post": { + "summary": "Obtener contenido de página", + "description": "Recupera el contenido completo de una página de documentación específica por su slug. Devuelve el contenido completo ensamblado a partir de todos los fragmentos de la página.", + "parameters": [ + { + "name": "domain", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "El identificador de dominio de tu URL `domain.mintlify.app`. Se puede encontrar al final de la URL de tu dashboard. Por ejemplo, `dashboard.mintlify.com/organization/domain` tiene un identificador de dominio `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 deseas recuperar (por ejemplo, `getting-started/quickstart`)." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Contenido de la página recuperado exitosamente", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "El slug de la página solicitada." + }, + "content": { + "type": "string", + "description": "El contenido completo ensamblado de la página." + } + } + } + } + } + }, + "400": { + "description": "Cuerpo de solicitud inválido", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "errors": { + "type": "object" + } + } + } + } + } + }, + "404": { + "description": "Página no encontrada", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + } + } + } + } + } } }, "components": { diff --git a/fr/api/assistant/get-page-content.mdx b/fr/api/assistant/get-page-content.mdx new file mode 100644 index 000000000..e44a2c6b0 --- /dev/null +++ b/fr/api/assistant/get-page-content.mdx @@ -0,0 +1,6 @@ +--- +title: "Récupérer le contenu d'une page" +description: "Récupérez le contenu complet d'une page de documentation spécifique par son slug." +openapi: "/fr/discovery-openapi.json POST /v1/page/{domain}" +keywords: [ "page", "contenu", "récupérer" ] +--- diff --git a/fr/discovery-openapi.json b/fr/discovery-openapi.json index d7eb00747..772e73579 100644 --- a/fr/discovery-openapi.json +++ b/fr/discovery-openapi.json @@ -840,6 +840,97 @@ } } } + }, + "/v1/page/{domain}": { + "post": { + "summary": "Récupérer le contenu d'une page", + "description": "Récupère le contenu complet d'une page de documentation spécifique par son slug. Retourne le contenu complet reconstitué à partir de tous les fragments de la page.", + "parameters": [ + { + "name": "domain", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "L'identifiant de domaine de votre URL `domain.mintlify.app`. Vous le trouverez à la fin de l'URL de votre Dashboard. Par exemple, `dashboard.mintlify.com/organization/domain` a pour identifiant de domaine `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 vous souhaitez récupérer le contenu (ex : `getting-started/quickstart`)." + } + } + } + } + } + }, + "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 slug de la page demandée." + }, + "content": { + "type": "string", + "description": "Le contenu complet reconstitué de la page." + } + } + } + } + } + }, + "400": { + "description": "Corps de requête invalide", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "errors": { + "type": "object" + } + } + } + } + } + }, + "404": { + "description": "Page non trouvée", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + } + } + } + } + } } }, "components": { diff --git a/zh/api/assistant/get-page-content.mdx b/zh/api/assistant/get-page-content.mdx new file mode 100644 index 000000000..dabbcc087 --- /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/discovery-openapi.json b/zh/discovery-openapi.json index 98ed67c78..bed885ade 100644 --- a/zh/discovery-openapi.json +++ b/zh/discovery-openapi.json @@ -840,6 +840,97 @@ } } } + }, + "/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": "要检索内容的页面路径（例如 `getting-started/quickstart`）。" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "成功检索页面内容", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "page": { + "type": "string", + "description": "请求的页面路径。" + }, + "content": { + "type": "string", + "description": "页面的完整拼接内容。" + } + } + } + } + } + }, + "400": { + "description": "无效的请求体", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "errors": { + "type": "object" + } + } + } + } + } + }, + "404": { + "description": "页面未找到", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + } + } + } + } + } + } } }, "components": {