mintlify__docs/es/api/introduction.mdx

---
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
---

<Info>
  La API REST requiere un [plan Pro o Enterprise](https://mintlify.com/pricing?ref=api).
</Info>

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.

<div id="endpoints">
  ## Endpoints
</div>

* [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.
* [Detect AI-sounding prose](/es/api/admin/deslop): Analiza una página en busca de prosa generada por IA y obtén sugerencias de reescritura hechas por humanos.
* [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.

<div id="common-use-cases">
  ### Casos de uso comunes
</div>

* **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).

<div id="base-url">
  ## URL base
</div>

Todas las solicitudes a la API REST de Mintlify usan la siguiente URL base:

```
https://api.mintlify.com
```


<div id="authentication">
  ## Autenticación
</div>

Puedes generar API keys en la [página de API keys](https://dashboard.mintlify.com/settings/organization/api-keys) de tu dashboard. Cada API key pertenece a una organización; puedes usar API keys en múltiples implementaciones dentro de la misma organización.

Puedes crear hasta 10 API keys por hora y por organización.

<div id="admin-api-key">
  ### Clave de la API de administrador
</div>

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), [Detect AI-sounding prose](/es/api/admin/deslop), [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.

<div id="assistant-api-key">
  ### key del Assistant API
</div>

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_`.

<Note>
  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.
</Note>