mintlify__docs/fr/api/introduction.mdx

---
title: "Introduction à l'API REST Mintlify"
description: "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."
keywords: ["REST API", "endpoints", "API keys"]
boost: 3
---

<Info>
  L'API REST nécessite une [offre Pro ou Enterprise](https://mintlify.com/pricing?ref=api).
</Info>

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.

<div id="endpoints">
  ## Endpoints
</div>

* [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.
* [Detect AI-sounding prose](/fr/api/admin/deslop) : Analysez une page pour détecter la prose générée par IA et obtenez des suggestions de réécriture humaine.
* [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.

<div id="common-use-cases">
  ### Cas d'utilisation courants
</div>

* **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 de l'Assistant** : Intégrez l'Assistant IA à votre produit, portail d'assistance ou outils internes avec [Create assistant message](/fr/api/assistant/create-assistant-message-v2).
* **Récupération de la documentation** : Recherchez et récupérez la documentation pour des expériences de recherche personnalisées avec [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).

<div id="base-url">
  ## URL de base
</div>

Toutes les requêtes vers l'API REST Mintlify utilisent l'URL de base suivante :

```
https://api.mintlify.com
```


<div id="authentication">
  ## Authentification
</div>

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.

<div id="admin-api-key">
  ### Clé d'API administrateur
</div>

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), [Detect AI-sounding prose](/fr/api/admin/deslop), [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.

<div id="assistant-api-key">
  ### Clé d'API de l'Assistant
</div>

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_`.

<Note>
  Les requêtes Search documentation et Get page content ne consomment pas de crédits. Les requêtes Create assistant message utilisent des crédits et peuvent entraîner des dépassements.
</Note>