Introducción

Desencadenar actualizaciones, integrar el Asistente de IA y más

La API REST de Mintlify te permite interactuar programáticamente con tu documentación, desencadenar actualizaciones e integrar experiencias de chat con IA.

​

Endpoints

• Activar actualización: Activa una actualización de tu sitio cuando lo desees.
• Obtener el estado de la actualización: Obtén el estado de una actualización y otros detalles sobre tu documentación.
• Generar mensaje del assistant: Inserta el assistant, entrenado con tu documentación, en cualquier aplicación que elijas.
• Buscar en la documentación: Busca en tu documentación.

​

Autenticación

Puedes generar una API key desde el dashboard. Las API keys están asociadas a toda la organización y pueden usarse en varias implementaciones.

​

Admin API key

La admin API key se utiliza para los endpoints Trigger update y Get update status.

Las admin API keys comienzan con el prefijo mint_. Mantén tus admin API keys en secreto.

​

Assistant API key

La assistant API key se utiliza para los endpoints Generate assistant message y Search documentation.

Las assistant API keys comienzan con el prefijo mint_dsc_.

La key de la assistant API es un token del lado del servidor que debe mantenerse en secreto.

El token de la assistant API es un token público que puede referenciarse en tu código de frontend.

Las llamadas que usen el token de la assistant API pueden generar costos: ya sea usando tus créditos del Asistente de IA o incurriendo en sobrecargos.