mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
f2a988ab82
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
63 lines
4.7 KiB
Plaintext
63 lines
4.7 KiB
Plaintext
---
|
||
title: "Introduction"
|
||
description: "Déclenchez des mises à jour, intégrez l’Assistant IA, exportez les données d’analyse, et plus encore"
|
||
keywords: ["REST API", "endpoints", "API keys"]
|
||
---
|
||
|
||
L’API REST 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.
|
||
* [Create agent job](/fr/api/agent/create-agent-job): Créez une tâche d’agent pour modifier automatiquement votre documentation.
|
||
* [Get agent job](/fr/api/agent/get-agent-job): Récupérez les détails et le statut d’une tâche d’agent spécifique.
|
||
* [Get all agent jobs](/fr/api/agent/get-all-jobs): Récupérez toutes les tâches d’agent pour un domain.
|
||
* [Generate assistant message](/fr/api/assistant/create-assistant-message): 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 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.
|
||
|
||
<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).
|
||
* **Intégrations personnalisées** : Intégrez l’Assistant IA à votre produit, portail d’assistance ou outils internes avec [Generate assistant message](/fr/api/assistant/create-assistant-message) et [Search documentation](/fr/api/assistant/search).
|
||
* **É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/create-agent-job), [Get agent job](/fr/api/agent/get-agent-job), et [Get all agent jobs](/fr/api/agent/get-all-jobs).
|
||
* **Export Analytics** : Exportez les retours utilisateurs et les conversations avec l’Assistant pour une analyse externe avec [Get user feedback](/fr/api/analytics/feedback) et [Get assistant conversations](/fr/api/analytics/assistant-conversations).
|
||
|
||
<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 [déclencher une mise à jour](/fr/api/update/trigger), [obtenir l’état de la mise à jour](/fr/api/update/status), [créer une tâche d’agent](/fr/api/agent/create-agent-job), [obtenir une tâche d’agent](/fr/api/agent/get-agent-job), [obtenir toutes les tâches d’agent](/fr/api/agent/get-all-jobs), [obtenir les retours utilisateurs](/fr/api/analytics/feedback) et [obtenir les conversations de l’Assistant](/fr/api/analytics/assistant-conversations).
|
||
|
||
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 [Générer un message de l’assistant](/fr/api/assistant/create-assistant-message) et [Rechercher dans la documentation](/fr/api/assistant/search).
|
||
|
||
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 public qui peut être référencé dans votre code front-end.
|
||
|
||
<Note>
|
||
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.
|
||
</Note> |