Points de terminaison
- Déclencher une mise à jour : Déclenchez une mise à jour de votre site lorsque vous le souhaitez.
- Obtenir l’état de la mise à jour : Obtenez l’état d’une mise à jour et d’autres détails sur votre documentation.
- Créer une tâche d’agent : Créez une tâche d’agent pour modifier automatiquement votre documentation.
- Obtenir une tâche d’agent : Récupérez les détails et l’état d’une tâche d’agent spécifique.
- Obtenir toutes les tâches d’agent : Récupérez toutes les tâches d’agent pour un domain.
- Générer un message de l’Assistant : Intégrez l’Assistant, entraîné sur votre documentation, dans n’importe quelle application de votre choix.
- Rechercher dans la documentation : Recherchez dans votre documentation.
Cas d’usage courants
- Déploiements automatisés : Déclenchez les mises à jour du site à intervalles définis ou lors d’événements spécifiques avec Trigger update et Get update status.
- Intégration CI/CD : Mettez à jour la documentation dans le cadre de votre pipeline de déploiement lorsque le code change avec Trigger update.
- Intégrations personnalisées : Intégrez l’Assistant IA dans votre produit, votre portail d’assistance ou vos outils internes avec Generate assistant message et Search documentation.
- Édition automatisée : Utilisez des tâches d’agent pour mettre à jour la documentation de manière programmatique et à grande échelle avec Create agent job, Get agent job, et Get all agent jobs.
Authentification
Clé d’API administrateur
mint_. Gardez vos clés d’API administrateur confidentielles.
La clé d’API administrateur est un jeton côté serveur. Gardez-la secrète.
Clé d’API de l’Assistant
mint_dsc_.
La clé d’API de l’Assistant est un jeton public qui peut être référencé dans votre code front-end.
Les appels utilisant le token de l’API de l’Assistant peuvent entraîner des coûts : soit en utilisant vos crédits d’Assistant, soit en engendrant des dépassements.