Skip to main content
Utilisez l’API REST Mintlify Index pour récupérer des connaissances techniques pour vos applications et agents. L’API prend en charge trois modes de récupération :
  • context assemble du contenu accompagné de ses sources dans une limite de jetons.
  • search renvoie des résultats classés issus de la documentation et du web.
  • contents récupère le contenu correspondant aux identifiants de résultats Mintlify ou aux URL de résultats sélectionnés.
L’API REST nécessite une clé d’API pour votre organisation. Le serveur MCP Index public ne nécessite pas de clé d’API.

​
URL de base

Envoyez les requêtes de l’API REST à l’adresse suivante :
Ajoutez un chemin de point de terminaison à cette URL de base, par exemple /context, /search ou /contents.

​
Authentification

Authentifiez chaque requête avec une clé d’API Index dans l’en-tête Authorization :
Les clés d’API Index commencent par mint_us_.
1

Créer une clé d’API Index

Ouvrez la page des clés d’API dans votre tableau de bord et créez une clé d’API Index.Si ce type de clé n’est pas disponible, votre organisation n’a pas accès à l’API REST Index.
2

Stocker la clé en toute sécurité

Enregistrez la clé dans une variable d’environnement côté serveur. Mintlify n’affiche la clé complète qu’au moment de sa création. Stockez-la en lieu sûr.
N’exposez pas une clé d’API Index dans du code côté client et ne la validez pas dans le contrôle de version.
3

Construire le contexte

Envoyez votre première requête au point de terminaison context :
Une réponse réussie inclut le contexte assemblé avec les URL sources, le nombre de résultats utilisés et le nombre de jetons générés.

​
Limites de débit

Les limites de l’API REST s’appliquent à chaque organisation Mintlify. Toutes les clés d’API d’une organisation partagent la même limite : Les requêtes dépassant l’une ou l’autre limite renvoient 429 Too Many Requests. Utilisez un back-off exponentiel avant de réessayer.

​
Erreurs

Sujets connexes

Introduction à l'API REST Mintlifyllms.txtMintlify Index