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.
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.
Autenticación
Clave de la API de administrador
mint_. Mantén en secreto tus claves de la API de administrador.
La clave de la API de administrador es un token del lado del servidor. Manténla en secreto.
key del Assistant API
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.