Introduction

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

L’API REST de Mintlify vous permet d’interagir programmatiquement 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é d’API via le tableau de bord. Les clés d’API sont associées à toute l’organisation et peuvent être utilisées sur plusieurs déploiements.

​

Clé d’API administrateur

La clé d’API administrateur est utilisée pour les points de terminaison Déclencher une mise à jour et Obtenir l’état de la mise à jour.

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

​

Clé d’API Assistant

La clé d’API de l’Assistant est utilisée pour les points de terminaison Générer un message d’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 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 utilisant vos crédits d’Assistant IA, soit en générant des dépassements.