Introducción

Lanza actualizaciones, integra el assistant, exporta datos de Analytics y más

La REST 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: Activa una actualización de tu sitio cuando lo desees.
• Get update status: Obtén el estado de una actualización y otros detalles de tu documentación.
• Create agent job: Crea un trabajo de agente para editar tu documentación automáticamente.
• Get agent job: Obtén los detalles y el estado de un trabajo de agente específico.
• Get all agent jobs: Obtén todos los trabajos de agente para un domain.
• Generate assistant message: Integra el assistant, entrenado con tu documentación, en cualquier aplicación que elijas.
• Search documentation: Busca en tu documentación.
• Get user feedback: Exporta los comentarios de los usuarios de tu documentación.
• Get assistant conversations: Exporta el historial de conversaciones del Asistente de IA.

​

Casos de uso comunes

• Implementaciones automatizadas: Activa actualizaciones del sitio en intervalos definidos o cuando se produzcan determinados eventos con Trigger update y Get update status.
• Integración CI/CD: Actualiza la documentación como parte de tu pipeline de implementación cuando cambie el código con Trigger update.
• Integraciones personalizadas: Integra el Asistente de IA en tu producto, portal de soporte o herramientas internas con Generate assistant message y Search documentation.
• Edición automatizada: Usa trabajos de agente para actualizar la documentación de forma programática y a escala con Create agent job, Get agent job y Get all agent jobs.
• Exportación de Analytics: Exporta comentarios de usuarios y conversaciones con el Asistente de IA para análisis externo con Get user feedback y Get assistant conversations.

​

Autenticación

Puedes generar API keys en la página de 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.

​

Clave de la API de administrador

Usa la clave de la API de administrador para autenticar solicitudes a Activar actualización, Obtener estado de la actualización, Crear tarea de agente, Obtener tarea de agente, Obtener todas las tareas de agente, Obtener comentarios de los usuarios y Obtener conversaciones del assistant.

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 Generate assistant message y Search documentation.

Las keys del Assistant API comienzan con el prefijo mint_dsc_.

La key del Assistant API es un token público que puede referenciarse en tu código de frontend.

Las llamadas que usan el token del Assistant API pueden generar costos: ya sea usando tus créditos del assistant o incurriendo en excedentes.