Introduction

Déclenchez des mises à jour, intégrez l’Assistant IA, exportez les données d’analyse, et plus encore

L’API REST de Mintlify vous permet d’interagir programmatiquement avec votre documentation, de déclencher des mises à jour, d’intégrer des expériences de chat propulsées par l’IA et d’exporter les données d’analyse.

​

Endpoints

• Trigger update: Déclenchez une mise à jour de votre site quand vous le souhaitez.
• Get update status: Récupérez le statut d’une mise à jour et d’autres détails sur votre documentation.
• Create agent job: Créez une tâche d’agent pour modifier automatiquement votre documentation.
• Get agent job: Récupérez les détails et le statut d’une tâche d’agent spécifique.
• Get all agent jobs: Récupérez toutes les tâches d’agent pour un domain.
• Generate assistant message: Intégrez l’Assistant, entraîné sur votre documentation, dans n’importe quelle application de votre choix.
• Search documentation: Effectuez une recherche dans votre documentation.
• Get user feedback: Exportez les retours utilisateurs issus de votre documentation.
• Get assistant conversations: Exportez l’historique des conversations de l’Assistant IA.

​

Cas d’utilisation courants

• Déploiements automatisés : Déclenchez les mises à jour du site à intervalles réguliers ou lorsqu’un événement se produit 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 à votre produit, portail d’assistance ou outils internes avec Generate assistant message et Search documentation.
• Édition automatisée : Utilisez des jobs 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.
• Export Analytics : Exportez les retours utilisateurs et les conversations avec l’Assistant pour une analyse externe avec Get user feedback et Get assistant conversations.

​

Authentification

Générez des clés d’API depuis la page API keys de votre Dashboard. Les clés d’API sont associées à toute l’organisation et peuvent être utilisées sur plusieurs déploiements au sein de la même organisation.

Vous pouvez créer jusqu’à 10 clés d’API par heure et par organisation.

​

Clé d’API administrateur

Utilisez la clé d’API administrateur pour authentifier les requêtes vers déclencher une mise à jour, obtenir l’état de la mise à jour, créer une tâche d’agent, obtenir une tâche d’agent, obtenir toutes les tâches d’agent, obtenir les retours utilisateurs et obtenir les conversations de l’Assistant.

Les clés d’API administrateur commencent par le préfixe mint_.

La clé d’API administrateur est un secret côté serveur. Ne l’exposez pas dans du code côté client.

​

Clé d’API de l’Assistant

Utilisez la clé d’API de l’Assistant pour authentifier les requêtes vers les points de terminaison Générer un message de l’assistant et Rechercher dans la documentation.

Les clés d’API de l’Assistant commencent par le préfixe 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.