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.
• Générer un message de l’Assistant: Intégrez l’Assistant, entraîné sur votre documentation, dans l’application de votre choix.
• Rechercher dans la documentation: Recherchez dans votre documentation.

Authentification

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

Clé API d’administration

La clé API d’administration est utilisée pour les endpoints Déclencher une mise à jour et Obtenir le statut de mise à jour.

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

Clé d’API 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 clé d’API de l’Assistant est un jeton côté serveur qui doit rester secret.

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

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