Introduction

Utilisez l’API REST de Mintlify pour déclencher des déploiements, intégrer un assistant IA, exporter des données d’analyse et gérer la documentation de manière programmatique.

L’API REST (Representational State Transfer) 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.
• Trigger preview deployment: Créez ou reconstruisez un déploiement de prévisualisation pour une branche spécifique.
• 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.
• Send follow-up message: Envoyez un message de suivi à une tâche d’agent existante.
• Create 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 page content: Récupérez le contenu textuel complet d’une page de documentation.
• Get user feedback: Exportez les retours utilisateurs issus de votre documentation.
• Get assistant conversations: Exportez l’historique des conversations de l’Assistant IA.
• Get assistant caller stats: Récupérez une ventilation du nombre de requêtes de l’assistant par type d’appelant.

​

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.
• Déploiements de prévisualisation : Créez des déploiements de prévisualisation pour des branches dans votre pipeline CI/CD avec Trigger preview deployment.
• Intégrations personnalisées : Intégrez l’Assistant IA à votre produit, portail d’assistance ou outils internes avec Create assistant message, Search documentation et Get page content.
• É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 Send follow-up message.
• Export Analytics : Exportez les retours utilisateurs, les conversations de l’Assistant et les données de visiteurs pour une analyse externe avec Get user feedback, Get assistant conversations et Get assistant caller stats.

​

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 Trigger update, Get update status, Trigger preview deployment, Create agent job, Get agent job, Send follow-up message, Get user feedback, Get assistant conversations et Get assistant caller stats.

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 Create assistant message, Search documentation et Get page content.

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.