Introduction

Déclenchez des mises à jour, intégrez l’Assistant IA et plus encore

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

​

Endpoints

• Déclencher une mise à jour: Déclenchez une mise à jour de votre site quand 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 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.

​

Authentification

Vous pouvez générer une clé d’API via le Dashboard. Les clés d’API sont associées à l’ensemble d’une organisation et peuvent être utilisées sur plusieurs déploiements.

​

Clé d’API administrateur

La clé d’API administrateur est utilisée pour déclencher une mise à jour, obtenir l’état de mise à jour ainsi que pour tous les endpoints d’agent.

Les clés d’API administrateur commencent par le préfixe mint_. Gardez vos clés d’API administrateur secrètes.

​

Clé d’API de l’Assistant

La clé d’API de l’Assistant est utilisée pour les endpoints Generate assistant message et Search documentation.

Les clés d’API de l’Assistant commencent par le préfixe mint_dsc_.

La key d’API de l’Assistant est un jeton côté serveur qui doit rester secret.

Le token d’API de l’Assistant est un jeton public qui peut être référencé dans votre code frontend.

Les appels utilisant le token d’API de l’Assistant peuvent entraîner des coûts : soit en utilisant vos crédits d’Assistant IA, soit en générant des dépassements.