> ## Documentation Index
> Fetch the complete documentation index at: https://tomee-mintlify-4f22647b.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Introduction
> Utilisez l'API REST de Mintlify pour déclencher des déploiements, intégrer un assistant IA, exporter des analyses et gérer la documentation par code.
L'API REST nécessite une [offre Pro ou Enterprise](https://mintlify.com/pricing?ref=api).
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](/fr/api/update/trigger): Déclenchez une mise à jour de votre site quand vous le souhaitez.
* [Get update status](/fr/api/update/status): Récupérez le statut d'une mise à jour et d'autres détails sur votre documentation.
* [Trigger preview deployment](/fr/api/preview/trigger): Créez ou mettez à jour un déploiement de prévisualisation pour une branche spécifique.
* [Trigger automation](/fr/api/automations/trigger): Exécute une automatisation planifiée à la demande.
* [Create agent job](/fr/api/agent/v2/create-agent-job): Créez une tâche d'agent pour modifier automatiquement votre documentation.
* [Get agent job](/fr/api/agent/v2/get-agent-job): Récupérez les détails et le statut d'une tâche d'agent spécifique.
* [Send follow-up message](/fr/api/agent/v2/send-message): Envoyez un message de suivi à une tâche d'agent existante.
* [Create assistant message](/fr/api/assistant/create-assistant-message-v2): Intégrez l'Assistant, entraîné sur votre documentation, dans n'importe quelle application de votre choix.
* [Search documentation](/fr/api/assistant/search): Effectuez une recherche dans votre documentation.
* [Get page content](/fr/api/assistant/get-page-content): Récupérez le contenu textuel complet d'une page de documentation.
* [Get user feedback](/fr/api/analytics/feedback): Exportez les retours utilisateurs issus de votre documentation.
* [Get assistant conversations](/fr/api/analytics/assistant-conversations): Exportez l'historique des conversations de l'Assistant IA.
* [Get assistant caller stats](/fr/api/analytics/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](/fr/api/update/trigger) et [Get update status](/fr/api/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](/fr/api/update/trigger).
* **Déploiements de prévisualisation** : Créez ou mettez à jour des déploiements de prévisualisation de manière programmatique dans votre pipeline CI/CD avec [Trigger preview deployment](/fr/api/preview/trigger).
* **Automatisations à la demande** : Exécutez des automatisations planifiées depuis vos propres outils, comme un pipeline CI/CD ou un script de version, avec [Trigger automation](/fr/api/automations/trigger).
* **Intégrations personnalisées** : Intégrez l'Assistant IA à votre produit, portail d'assistance ou outils internes avec [Create assistant message](/fr/api/assistant/create-assistant-message-v2), [Search documentation](/fr/api/assistant/search) et [Get page content](/fr/api/assistant/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](/fr/api/agent/v2/create-agent-job), [Get agent job](/fr/api/agent/v2/get-agent-job), et [Send follow-up message](/fr/api/agent/v2/send-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](/fr/api/analytics/feedback), [Get assistant conversations](/fr/api/analytics/assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/assistant-caller-stats).
## URL de base
Tous les endpoints de l'API REST Mintlify sont accessibles depuis :
```
https://api.mintlify.com
```
La page de référence de chaque endpoint indique le chemin complet et la méthode HTTP à appeler.
## Authentification
Générez des clés d'API depuis la [page API keys](https://dashboard.mintlify.com/settings/organization/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](/fr/api/update/trigger), [Get update status](/fr/api/update/status), [Trigger preview deployment](/fr/api/preview/trigger), [Trigger automation](/fr/api/automations/trigger), [Create agent job](/fr/api/agent/v2/create-agent-job), [Get agent job](/fr/api/agent/v2/get-agent-job), [Send follow-up message](/fr/api/agent/v2/send-message), [Get user feedback](/fr/api/analytics/feedback), [Get assistant conversations](/fr/api/analytics/assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/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](/fr/api/assistant/create-assistant-message-v2), [Search documentation](/fr/api/assistant/search) et [Get page content](/fr/api/assistant/get-page-content).
Les clés d'API de l'Assistant commencent par le préfixe `mint_dsc_`.
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.