diff --git a/agent/index.mdx b/agent/index.mdx deleted file mode 100644 index 139e57bbcf..0000000000 --- a/agent/index.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "What is the agent?" -description: "Learn how the Mintlify agent researches, plans, and writes documentation, then opens pull requests with proposed changes for your team to review." -keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"] ---- - -import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx"; - - - The agent requires a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=agent). - - -The agent is an AI tool that creates pull requests with proposed changes to your documentation based on your prompts. When you send a request, the agent: - -- **Researches**: Searches and reads your existing documentation, any connected repositories, relevant context, and the web. -- **Plans**: Creates a structured task list for complex documentation work. -- **Writes**: Generates or updates content following writing standards and best practices. -- **Validates**: Runs Mintlify CLI checks to ensure documentation builds correctly. -- **Publishes changes**: Opens a pull request with proposed changes for review, or commits directly to your deployment branch, depending on your [review process setting](#choose-how-the-agent-publishes-changes). - -## What you can do with the agent - -Use the agent to: - -- Write new content based on your prompts, pull requests, Slack threads, or file attachments. -- Update existing documentation for new features or API changes. -- Process and include images, diagrams, and other files from Slack attachments. -- Search and revise code examples and API references across your docs. -- Reference source code from any repository that has the Mintlify GitHub App installed. -- Automate documentation maintenance with automations. -- Answer questions about your docs and technical writing topics. -- Address code review feedback to maintain documentation quality. -- Capture knowledge from Slack conversations and pull requests before it gets lost. -- Navigate and coordinate changes across multiple files and directories efficiently. - -## Connect your GitHub account - -By default, the agent opens pull requests attributed to the Mintlify bot. To attribute pull requests to you, connect your GitHub account on the [My profile](https://app.mintlify.com/settings/account) page of the dashboard. - -## Choose how the agent publishes changes - -By default, the agent opens a pull request for every change so your team can review it before it ships. If Mintlify hosts your deployment, the agent commits changes directly to your deployment branch so changes publish immediately. - -For deployments connected to your own Git provider, click **Configure Slack** on the [Automations](https://app.mintlify.com/products/automations) page of your dashboard, then set **Review process** in Slack settings: - -- **Create a pull request**: The agent commits to a new branch and opens a pull request against your deploy branch. Use this option when you want a human to review changes before they publish. -- **Push to main**: The agent commits directly to your deploy branch, and changes publish as soon as the agent finishes. Use this option when you trust the agent to publish without review, for example on a staging deployment. - - - If your deploy branch has branch protection rules that block direct pushes, the agent opens a pull request even if you set **Review process** to **Push to main**. - - -## Connect repositories as context - -The agent can only access repositories that you connect through the Mintlify GitHub App. Configure which repositories the agent can access in the [GitHub App settings](https://github.com/apps/mintlify/installations/new). For GitLab, use [Git Settings](https://app.mintlify.com/settings/deployment/git-settings). - -## Use a static IP for Git requests - - - Static agent egress requires an [Enterprise plan](https://mintlify.com/pricing?ref=static-agent-egress). - - -If your Git provider restricts access with an IP allowlist, Mintlify can route Git requests from agent sandboxes through a static IP address. - -Contact Mintlify about the deployment that you want to enable static agent egress for. Once enabled, the static address applies to Git operations from the agent and automations, including cloning, fetching, and pushing connected repositories. - - - Static agent egress applies only to Git requests from agent sandboxes. Other outbound requests do not use this static IP address. - - -## Use AI tools alongside the agent - -The agent works asynchronously through pull requests, but you can also use AI coding tools like Cursor or Claude Code locally for fast, iterative edits. Install the Mintlify [skill](/ai/skillmd) and connect the [Model Context Protocol (MCP) server](/ai/model-context-protocol) so your editor has the same context the agent uses. - -To let an external agent edit your content directly through MCP tool calls, connect it to the [Mintlify MCP server](/ai/mintlify-mcp). - - - -## Next steps - - -Add the agent to your Slack workspace. - - -Configure the agent with an `AGENTS.md` file. - - -Get better results with focused prompts. - - -Automate recurring tasks and documentation maintenance with automations. - diff --git a/agent/slack.mdx b/agent/slack.mdx index b9df571064..d9fd4fff5e 100644 --- a/agent/slack.mdx +++ b/agent/slack.mdx @@ -4,11 +4,15 @@ description: "Install the Mintlify agent in Slack to ask questions about your pr keywords: ["Slack integration", "Slack bot", "team collaboration", "agent integration", "knowledge capture"] --- +hello @[6a93a19aa2be8a5bfaef4de9]! rf rb + +YOOOO + If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify app before you connect it. -Use the agent in Slack to update your content, ask questions, and capture team knowledge. Mention the agent in a channel to use it collaboratively, or send it a direct message to use it privately. +Use the agent in Slack to update your content, ask questions, and capture team knowledge. Mention the agent in a channelfbdzfb to use it collaboratively, or send it a direct message to use it privately. WOOHOO The Slack app and third-party integrations work together. Install the Slack app to talk with the agent and give the agent and automation runs access to permitted Slack content. Then connect [integrations](/automations/integrations) so the agent can also use context from apps like Notion, Jira, Linear, or Google Drive. @@ -23,7 +27,7 @@ Use the agent in Slack to update your content, ask questions, and capture team k 1. Navigate to the [Automations](https://app.mintlify.com/products/automations) page in your dashboard. -2. Click **Connect Slack**. +2. Click **Connect Slack**.afawef 3. Follow the Slack prompts to install the `mintlify` app in your workspace and grant the requested permissions. 4. Confirm the connection in your Mintlify dashboard to your Slack workspace. 5. Test that the agent is working and responds when you: diff --git a/agent/use-cases.mdx b/agent/use-cases.mdx index 66e510f844..f5060b00fc 100644 --- a/agent/use-cases.mdx +++ b/agent/use-cases.mdx @@ -1,11 +1,14 @@ --- title: "Mintlify agent use cases and examples" sidebarTitle: "Use cases" -description: "Explore real-world examples of using the Mintlify agent to automate documentation updates, capture knowledge, and maintain accurate docs." -keywords: ["agent automations", "documentation automations", "automation examples"] +description: "Explore real-world examples of using the Mintlify agent to automate documentation updates, capture knowledge, and maintain accurate docs. " +keywords: + - "agent automations" + - "documentation automations" + - "automation examples" --- -The agent assists with many different documentation tasks. These examples show some of the ways you can integrate the agent into your documentation process. Try an approach that fits how your team currently works and adapt it to your specific needs. +The agent assists with many different documentation tasks. These examples show some of the ways you can integrate the agent into your documentation process. Try an approach that fits how your team currently works and adapt it to your specific needs. WE HAVE HELLA USE CASES ## Iterate on a prompt in a Slack thread diff --git a/another-new-page.mdx b/another-new-page.mdx new file mode 100644 index 0000000000..56fd62c872 --- /dev/null +++ b/another-new-page.mdx @@ -0,0 +1,3 @@ +--- +title: "Another new page" +--- diff --git a/api-playground/websocket-playground.mdx b/api-playground/websocket-playground.mdx index b9ef6c30aa..887483feee 100644 --- a/api-playground/websocket-playground.mdx +++ b/api-playground/websocket-playground.mdx @@ -3,3 +3,5 @@ title: "WebSocket playground" description: "Add interactive WebSocket playgrounds to your documentation so users can test real-time connections, send messages, and view event streams." asyncapi: "/asyncapi.yaml channelOne" --- + +efawefwef diff --git a/cli/mdx-extension.mdx b/cli/mdx-extension.mdx index d13c311455..3c6259771a 100644 --- a/cli/mdx-extension.mdx +++ b/cli/mdx-extension.mdx @@ -1,12 +1,19 @@ --- title: "Mintlify MDX extension" -description: "Install the Mintlify MDX extension for autocomplete, inline diagnostics, hover docs, a visual editor, and an in-editor preview for writing MDX locally." -keywords: ["Cursor", "MDX", "autocomplete", "diagnostics", "IntelliSense", "preview", "editor", "visual mode"] +description: "Install the Mintlify MDX extension for autocomplete, inline diagnostics, hover documentation, and an in-editor preview while you write MDX locally." +keywords: + - "Cursor" + - "MDX" + - "autocomplete" + - "diagnostics" + - "IntelliSense" + - "preview" + - "editor" --- The Mintlify MDX extension adds language support for Mintlify projects to VS Code, Cursor, Devin Desktop, and other editors that support the VS Code extension API. The extension knows every built-in component and property, so you get autocomplete as you type, and it reports unknown components, invalid properties, and unresolved snippet imports. -The extension also opens `.mdx` files in a visual editor and runs a live preview inside your editor, so you can write and see rendered output without switching to a browser. +The extension also opens `.mdx` files in a visual editor and opens `.mdx` files in a visual editor and runs a live preview inside your editor, so you can write and see rendered output without switching to a browser. ## Prerequisites @@ -34,9 +41,9 @@ The extension activates when you open an `.mdx` file or a workspace containing a ## Autocomplete -Type `<` to view every built-in component. Autocomplete suggests components' properties and values inside tags, closing tags after ``. +Type `<` to view every built-in component. Autocomplete suggests components' properties and values inside tags, closing tags after ``, closing tags after ``. -The extension suggests components that you import from [reusable snippets](/create/reusable-snippets) alongside built-in ones. `className`, `id`, and `style` are offered on every component and HTML element, and typing inside `className="…"` suggests Tailwind utility classes, including variants like `md:` and `hover:`. +The extension suggests components that you import from [reusable snippets](/create/reusable-snippets) alongside built-in ones. `className`, `id`, and `style` are offered on every component and HTML element, and typing inside `className="…"` suggests Tailwind utility classes, including variants like `md:` and `hover:`. `className`, `id`, and `style` are offered on every component and HTML element, and typing inside `className="…"` suggests Tailwind utility classes, including variants like `md:` and `hover:`. ## Diagnostics @@ -81,18 +88,18 @@ Use the gutter chevrons to collapse regions of a page: The extension validates `docs.json` against the [Mintlify schema](https://mintlify.com/docs.json). -## Visual mode +## Visual modeVisual mode -Open any `.mdx` file in visual mode to edit the page in a rich editor like the one in the Mintlify dashboard, with headings, lists, tables, links, callouts, cards, steps, tabs, accordions, code blocks, and images all editable in place. +Open any `.mdx` file in visual mode to edit the page in a rich editor like the one in the Mintlify dashboard, with headings, lists, tables, links, callouts, cards, steps, tabs, accordions, code blocks, and images all editable in placy `.mdx` file in visual mode to edit the page in a rich editor like the one in the Mintlify dashboard, with headings, lists, tables, links, callouts, cards, steps, tabs, accordions, code blocks, and images all editable in place. -To switch between visual mode and the text editor: +To switch between visual mode and the text editor:o switch between visual mode and the text editor: -- Press Cmd+Shift+V (macOS) or Ctrl+Shift+V (Windows). +- Press Cmd\+Shift\+V (macOS) or Ctrl\+Shift\+V (Windows). - Or use the editor picker at the right end of the breadcrumbs row. Use the gear icon in the title bar to pick which editor `.mdx` files open with by default. -Markdown shortcuts work as you type (`#` for a heading, `-` for a list item, `**bold**`, `` `code` ``), and the toolbar and `/` menu insert components. Visual mode writes edits back as MDX through the same converter as [`mint format`](/cli/commands#mint-format), and preserves unfamiliar components as written. +Markdown shortcuts work as you type (`#` for a heading, `-` for a list item, `**bold**`, ``code``), and the toolbar and `/` menu insert components. Visual mode writes edits back as MDX through the same converter as [`mint format`](/cli/commands#mint-format), and preserves unfamiliar components as written. ### Snippet forms @@ -116,29 +123,92 @@ export const ProductCard = ({ name, icon, tier = 'Free', seats = 1, featured = f The following types produce the matching form inputs: -| Type | Input | -| ----------------- | ---------------------------- | -| `string` | Text box | -| `text` (or `markdown`) | Multi-line text box | -| `boolean` | Checkbox | -| `number` | Number box | -| `'a' \| 'b'` | Dropdown of those values | -| `image` | Path box with a thumbnail | -| `url` | Link box | -| `color` | Text box with a swatch | -| anything else | Raw `{…}` expression | +| Type | Input | +| --- | --- | +| `string` | Text box | +| `text` (or `markdown`) | Multi-line text box | +| `boolean` | Checkbox | +| `number` | Number box | +| `'a' \| 'b'` | Dropdown of those values | +| `image` | Path box with a thumbnail | +| `url` | Link box | +| `color` | Text box with a swatch | +| anything else | Raw `{…}` expression | + +Brackets (`[name]`) mark a prop optional. A documented prop without brackets shows a required marker. `[name=value]` supplies a default when the component's signature doesn't already have one. The first line of the comment is the description shown in the form header and the **Insert** menu. + +`children` is never a field. Visual mode leaves the tag's body as written and summarizes it under the form. Switch to the text editor to edit it. + +Imported snippets also appear in the **\+ Insert** menu and the `/` menu. + +## Docs sidebar + +The Mintlify view in the activity bar mirrors your `docs.json` navigation tree. Top-level products and tabs stay at the root, with their navigation nested in expandable rows. The sidebar uses icons from `docs.json` and page frontmatter, and page labels come from `sidebarTitle` or `title`. Selecting a page opens it in visual mode. + +Use the **\+** action to add groups, tabs, dropdowns, anchors, languages, products, and versions. Drag rows to reorder them, or drop a page on a group to move it to the top of that group. The tree moves immediately, then Mintlify saves the change to `docs.json`. + +The tree follows the active page and reloads when `docs.json` or a page changes. + +## Preview in your editor + +Open an `.mdx` file and select the preview icon in the editor title bar, or right-click the file and select **Preview Mintlify**. A preview panel opens beside your editor and renders the page. + +The preview toolbar has back, forward, and reload buttons, an address box, and a **Follow editor** toggle. Type a path like `/quickstart` in the address box and press Enter to navigate to that page. With **Follow editor** on, the preview switches pages as you change files in your editor. + +Press Cmd\+F (macOS) or Ctrl\+F (Windows) inside the preview to open a find bar for the rendered page. Enter and Shift\+Enter step through matches. Esc closes the find bar. + +- Press Cmd\+Shift\+V (macOS) or Ctrl\+Shift\+V (Windows). +- Or use the editor picker at the right end of the breadcrumbs row. + +Use the gear icon in the title bar to pick which editor `.mdx` files open with by default. + +Markdown shortcuts work as you type (`#` for a heading, `-` for a list item, `**bold**`, ``code``), and the toolbar and `/` menu insert components. Visual mode writes edits back as MDX through the same converter as [`mint format`](/cli/commands#mint-format), and preserves unfamiliar components as written. + +### Snippet forms + +In visual mode, a component imported from a snippet appears as a form with one input per prop instead of an opaque tag. Visual mode infers fields from the props in the component's function signature and their default values, so a default of `true` becomes a checkbox, `2` becomes a number box, `icon` or `logo` becomes an image path with a thumbnail, and `href` or `url` becomes a link. + +To control the inputs, document the component with a JSDoc `@param` comment right before the export. In `.jsx` and `.tsx` files use a `/** … */` block. In `.mdx` snippets, use an MDX comment (`{/* … */}`) so it doesn't render: + +```mdx +{/* + A product tile with a price and a call to action. + @param {string} name - Product name, shown as the title + @param {image} [icon] - Path to a square icon under /images + @param {'Free' | 'Pro' | 'Enterprise'} [tier=Free] - Which plan it belongs to + @param {number} [seats=1] - Seats included + @param {boolean} [featured] - Highlight the card + @param {url} [href] - Where the button goes + @param {text} [summary] - One or two sentences under the title +*/} +export const ProductCard = ({ name, icon, tier = 'Free', seats = 1, featured = false, href, summary, children }) => ( ... ); +``` + +The following types produce the matching form inputs: + +| Type | Input | +| --- | --- | +| `string` | Text box | +| `text` (or `markdown`) | Multi-line text box | +| `boolean` | Checkbox | +| `number` | Number box | +| `'a' \| 'b'` | Dropdown of those values | +| `image` | Path box with a thumbnail | +| `url` | Link box | +| `color` | Text box with a swatch | +| anything else | Raw `{…}` expression | Brackets (`[name]`) mark a prop optional. A documented prop without brackets shows a required marker. `[name=value]` supplies a default when the component's signature doesn't already have one. The first line of the comment is the description shown in the form header and the **Insert** menu. `children` is never a field. Visual mode leaves the tag's body as written and summarizes it under the form. Switch to the text editor to edit it. -Imported snippets also appear in the **+ Insert** menu and the `/` menu. +Imported snippets also appear in the **\+ Insert** menu and the `/` menu. ## Docs sidebar The Mintlify view in the activity bar mirrors your `docs.json` navigation tree. Top-level products and tabs stay at the root, with their navigation nested in expandable rows. The sidebar uses icons from `docs.json` and page frontmatter, and page labels come from `sidebarTitle` or `title`. Selecting a page opens it in visual mode. -Use the **+** action to add groups, tabs, dropdowns, anchors, languages, products, and versions. Drag rows to reorder them, or drop a page on a group to move it to the top of that group. The tree moves immediately, then Mintlify saves the change to `docs.json`. +Use the **\+** action to add groups, tabs, dropdowns, anchors, languages, products, and versions. Drag rows to reorder them, or drop a page on a group to move it to the top of that group. The tree moves immediately, then Mintlify saves the change to `docs.json`. The tree follows the active page and reloads when `docs.json` or a page changes. @@ -148,7 +218,7 @@ Open an `.mdx` file and select the preview icon in the editor title bar, or righ The preview toolbar has back, forward, and reload buttons, an address box, and a **Follow editor** toggle. Type a path like `/quickstart` in the address box and press Enter to navigate to that page. With **Follow editor** on, the preview switches pages as you change files in your editor. -Press Cmd+F (macOS) or Ctrl+F (Windows) inside the preview to open a find bar for the rendered page. Enter and Shift+Enter step through matches. Esc closes the find bar. +Press Cmd\+F (macOS) or Ctrl\+F (Windows) inside the preview to open a find bar for the rendered page. Enter and Shift\+Enter step through matches. Esc closes the find bar. The in-editor preview renders in an iframe, so browser dev tools can't reach it. Select the **Open in browser** button in the preview toolbar, or run **Mintlify: Open preview in browser**, to open the page in your browser instead. @@ -207,9 +277,11 @@ For code formatting, use [Prettier](https://marketplace.visualstudio.com/items?i If the root is correct, run **Mintlify: Restart language server**. + Another MDX extension is likely also active. Open the Extensions view, search for `mdx`, and disable any other MDX extensions in this workspace. + Open the **Mintlify Preview** output channel to see the error from `mint dev`. @@ -218,6 +290,7 @@ For code formatting, use [Prettier](https://marketplace.visualstudio.com/items?i - `no docs.json found above this file`: Open the folder containing your `docs.json` file as your workspace. - `Invalid docs.json`: Run [`mint validate`](/cli/commands#mint-validate) to find the configuration error. + Absolute import paths resolve from your docs root, not from your file. Confirm the path matches the location of the snippet file relative to your `docs.json` file, and that the detected root is correct. diff --git a/docs.json b/docs.json index 70bd5a036e..65cf7d6ed9 100644 --- a/docs.json +++ b/docs.json @@ -51,7 +51,8 @@ "migration/gitbook", "migration/fern", "migration/document360", - "migration/manual" + "migration/manual", + "another-new-page" ] } ] @@ -246,7 +247,6 @@ { "group": "Agent", "pages": [ - "agent/index", "agent/slack", { "group": "Automations", diff --git a/es.json b/es.json index 8a3c4867a2..e86818505e 100644 --- a/es.json +++ b/es.json @@ -367,9 +367,7 @@ "groups": [ { "group": "Referencia de la API", - "pages": [ - "es/api/introduction" - ] + "pages": [] }, { "group": "Administración", diff --git a/es/api/introduction.mdx b/es/api/introduction.mdx deleted file mode 100644 index d245245f85..0000000000 --- a/es/api/introduction.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: "Introducción a la API REST de Mintlify" -description: "Usa la API REST de Mintlify para lanzar despliegues, integrar un asistente de IA, exportar Analytics y gestionar la documentación de forma programática." -keywords: ["REST API", "endpoints", "API keys"] -boost: 3 ---- - - - La API REST de la plataforma requiere un [plan Pro o Enterprise](https://mintlify.com/pricing?ref=api). - - La [API REST de Mintlify Index](/es/api/search-index/introduction) usa una clave de API y una URL base independientes. - - -La REST (Representational State Transfer) API de Mintlify te permite interactuar de forma programática con tu documentación, lanzar actualizaciones, integrar experiencias de chat impulsadas por IA y exportar datos de Analytics. - -
- ## Endpoints -
- -* [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. -* [Trigger preview deployment](/es/api/preview/trigger): Crea o actualiza una implementación de vista previa para una rama específica. -* [Trigger automation](/es/api/automations/trigger): Ejecuta una automatización programada bajo demanda. -* [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 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. -* [Get assistant caller stats](/es/api/analytics/assistant-caller-stats): Obtén un desglose de los recuentos de consultas del assistant por tipo de origen. - -
- ### Casos de uso comunes -
- -* **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). -* **Implementaciones de vista previa**: Crea o actualiza implementaciones de vista previa de forma programática en tu pipeline CI/CD con [Trigger preview deployment](/es/api/preview/trigger). -* **Automatizaciones bajo demanda**: Activa automatizaciones programadas desde tu pipeline CI/CD, scripts de versión u otras herramientas con [Trigger automation](/es/api/automations/trigger). -* **Integraciones del asistente**: 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). -* **Recuperación de documentación**: Busca y recupera documentación para experiencias de búsqueda personalizadas con [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, conversaciones del assistant y datos de visitantes para análisis externo con [Get user feedback](/es/api/analytics/feedback), [Get assistant conversations](/es/api/analytics/assistant-conversations) y [Get assistant caller stats](/es/api/analytics/assistant-caller-stats). - -
- ## URL base -
- -Todas las solicitudes a la API REST de Mintlify usan la siguiente URL base: - -``` -https://api.mintlify.com -``` - - -
- ## Autenticación -
- -Puedes generar API keys en la [página de API keys](https://dashboard.mintlify.com/settings/organization/api-keys) de tu dashboard. Las claves de API de administrador e Index pertenecen a una organización. Puedes usar las mismas claves en múltiples implementaciones dentro de la misma organización. Las claves de API del Assistant pertenecen al despliegue donde las creas. - -Puedes crear hasta 10 API keys por hora y por organización. - -Al crear una API key, puedes configurarla para que caduque en 7, 30, 60 o 90 días, o seleccionar **Sin caducidad**. Las nuevas API keys caducan en 90 días de forma predeterminada. La página de API keys muestra una insignia **Caduca en …** para las API keys que caducan en los próximos 7 días y una insignia **Caducada** para las que ya han caducado. Las API keys caducadas dejan de funcionar, por lo que debes rotarlas o reemplazarlas antes de la fecha de caducidad. - -Mintlify utiliza tres tipos de API keys, cada una con un conjunto diferente de endpoints: - -| Tipo de key | Prefijo | Se usa para | -| ----------------- | ----------- | ----------------------------------------------------------------------------- | -| Admin API key | `mint_` | Actualizaciones, tareas de agente y exportaciones de Analytics. Solo servidor. | -| Assistant API key | `mint_dsc_` | Mensajes del asistente, búsqueda de documentación y contenido de páginas. Usa un proxy en producción. | -| Index API key | `mint_us_` | Búsqueda de Index, ensamblaje de contexto y recuperación de contenido. Solo servidor. | - -
- ### Clave de la API de administrador -
- -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), [Trigger preview deployment](/es/api/preview/trigger), [Trigger automation](/es/api/automations/trigger), [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), [Get assistant conversations](/es/api/analytics/assistant-conversations) y [Get assistant caller stats](/es/api/analytics/assistant-caller-stats). - -Las claves de la API de administrador comienzan con el prefijo `mint_`. - -La clave de la API de administrador es un secreto del lado del servidor. No la expongas en código del lado del cliente. - -
- ### 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), [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_`. - - - Las solicitudes de Search documentation y Get page content no consumen créditos. Las solicitudes de Create assistant message usan créditos y pueden generar excedentes. - - -
- ### Clave de la API de Index -
- -Usa una clave de la API de Index para autenticar solicitudes a la [API REST de Mintlify Index](/es/search-index). Las claves de la API de Index comienzan con el prefijo `mint_us_`. - -La clave de la API de Index es un secreto del lado del servidor. No la expongas en código del lado del cliente. - -
- ### Restringir claves por dirección IP -
- -Puedes restringir opcionalmente una API key a una lista de direcciones IP o rangos CIDR permitidos. Cuando una key tiene una lista de permitidos, las solicitudes desde cualquier otra dirección IP se rechazan con una respuesta `403`. Las claves de las API de administrador, Assistant e Index admiten listas de permitidos. - -Configura la lista de permitidos al crear la key en la [página de API keys](https://dashboard.mintlify.com/settings/organization/api-keys) de tu dashboard. La lista de permitidos es fija durante la vida de la key; para cambiarla, elimina la key y crea una nueva. Si no configuras una lista de permitidos, la key acepta solicitudes desde cualquier dirección IP. - -Las entradas admiten: - -* Direcciones IPv4 e IPv6, por ejemplo `203.0.113.5` o `2001:db8::1`. -* Rangos CIDR, por ejemplo `198.51.100.0/24` o `2001:db8::/48`. - -No se permiten entradas comodín como `0.0.0.0/0` o `::/0`. - -Usa listas de IP permitidas cuando tu API key se llame desde un conjunto estable de IPs de salida, por ejemplo, un runner de CI/CD, una NAT estática o el servidor de tu backend. Evita las listas de permitidos para keys usadas desde portátiles de personas desarrolladoras u otros entornos con IPs cambiantes. - -
- ### Restringir claves de administrador por scope -
- -Puedes restringir opcionalmente una clave de la API de administrador a los scopes `read` o `write`. Los scopes se aplican solo a las claves de la API de administrador; las keys del Assistant API no se ven afectadas. - -Configura los scopes al crear la key en la [página de API keys](https://dashboard.mintlify.com/settings/organization/api-keys) de tu dashboard. Los scopes son fijos durante la vida de la key; para cambiarlos, elimina la key y crea una nueva. Si no configuras scopes, la key puede llamar a todos los endpoints de administrador (las keys existentes siguen funcionando). - -Mintlify deriva el scope requerido a partir del método HTTP de la solicitud: - -| Método HTTP | Scope requerido | -| -------------- | --------------- | -| `GET`, `HEAD` | `read` | -| Los demás | `write` | - -Una key con `write` también satisface `read`, por lo que `["read", "write"]` y `["write"]` permiten todos los endpoints. Las solicitudes que requieren un scope que la key no tiene se rechazan con una respuesta `403`. - -Solo se aceptan `read` y `write`. Cualquier otro valor devuelve una respuesta `400` al crear la key. - -
- ### Establecer una fecha de expiración -
- -Puedes establecer opcionalmente una fecha de expiración en cualquier API key al crearla. Cuando pasa la marca de tiempo de expiración, las solicitudes que usan la key se rechazan con una respuesta `401`. Todas las API keys admiten expiración. - -Configura la expiración en la [página de API keys](https://dashboard.mintlify.com/settings/organization/api-keys) de tu dashboard. La expiración es fija durante la vida de la key; para cambiarla, elimina la key y crea una nueva. Si no configuras una expiración, la key nunca expira. - -La expiración debe ser una marca de tiempo ISO 8601 en el futuro. Las marcas de tiempo pasadas o inválidas devuelven una respuesta `400` al crear la key. La expiración se devuelve como `expiresAt` al listar las keys, o `null` para las keys sin expiración. - -Usa expiraciones para credenciales de corta duración, como tokens de CI/CD, colaboradores externos o scripts puntuales. Rota las keys de larga duración creando una de reemplazo, actualizando tus integraciones y eliminando la anterior. diff --git a/optimize/seo.mdx b/optimize/seo.mdx index 66671d2f81..b5f044c0db 100644 --- a/optimize/seo.mdx +++ b/optimize/seo.mdx @@ -68,7 +68,7 @@ Mintlify adds [schema.org](https://schema.org) structured data to every indexabl Each page emits a connected `@graph` of entities with stable `@id`s: -- `Organization`: The publisher of your site. Derived from your site name, logo, and site URL, or configured explicitly with [`seo.organization`](/organize/settings-seo#seo). +- `Organization`: The publisher of your site. Derived from your site name, logo, and site URL, or configured explicitly with `seo.organization`. - `WebSite`: Your site. - `WebPage`: The current page, including its description and modification dates. - `BreadcrumbList`: The page's location in your navigation hierarchy, generated from your `docs.json` navigation. @@ -76,7 +76,7 @@ Each page emits a connected `@graph` of entities with stable `@id`s: Mintlify generates the structured data from page frontmatter and `docs.json` configurations, including the page title, description, keywords, canonical URL, last updated date, site name, and logo. The structured data doesn't include any fields without a corresponding value. Pages with `noindex: true` do not include structured data. -To change structured data, update the corresponding frontmatter fields or `docs.json` configurations. To control the publisher entity, including a stable `@id`, legal name, canonical logo, and `sameAs` profile links, set [`seo.organization`](/organize/settings-seo#seo) in your `docs.json`. +To change structured data, update the corresponding frontmatter fields or `docs.json` configurations. To control the publisher entity, including a stable `@id`, legal name, canonical logo, and `sameAs` profile links, set `seo.organization` in your `docs.json`. ## OG images @@ -105,7 +105,7 @@ To use a custom background image while keeping the auto-generated logo, title, a } ``` -See [`thumbnails`](/organize/settings-appearance#thumbnails) for the full list of customization options. +See `thumbnails` for the full list of customization options. **Static OG image for all pages** @@ -132,7 +132,7 @@ description: "Your page description" ``` - Setting `og:image` in meta tags, globally or per-page, replaces the auto-generated social preview with a static image. If you want Mintlify to automatically overlay your logo, page title, and description on a custom background, use [`thumbnails.background`](/organize/settings-appearance#param-thumbnails-background) instead. + Setting `og:image` in meta tags, globally or per-page, replaces the auto-generated social preview with a static image. If you want Mintlify to automatically overlay your logo, page title, and description on a custom background, use `thumbnails.background` instead. ## Global meta tags @@ -493,4 +493,4 @@ This setting works alongside other indexing controls: - Optimize image file sizes for faster loading - Use relevant images that support your content - \ No newline at end of file + diff --git a/untitled-page.mdx b/untitled-page.mdx new file mode 100644 index 0000000000..8b13789179 --- /dev/null +++ b/untitled-page.mdx @@ -0,0 +1 @@ +