Files
mintlify__docs/fr/api/introduction.mdx
locadex-agent[bot] 19d89bf8eb docs(locadex): add translations (#3016)
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
2026-01-30 17:17:09 -08:00

63 lines
5.2 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
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">
## Points de terminaison
</div>
* [Déclencher une mise à jour](/fr/api-reference/update/trigger) : Déclenchez une mise à jour de votre site lorsque vous le souhaitez.
* [Obtenir l’état de la mise à jour](/fr/api-reference/update/status) : Obtenez l’état d’une mise à jour et d’autres détails sur votre documentation.
* [Créer une tâche d’agent](/fr/api-reference/agent/create-agent-job) : Créez une tâche d’agent pour modifier automatiquement votre documentation.
* [Obtenir une tâche d’agent](/fr/api-reference/agent/get-agent-job) : Récupérez les détails et l’état d’une tâche d’agent spécifique.
* [Obtenir toutes les tâches d’agent](/fr/api-reference/agent/get-all-jobs) : Récupérez toutes les tâches d’agent pour un domaine.
* [Générer un message de l’Assistant](/fr/api-reference/assistant/create-assistant-message) : Intégrez l’Assistant, entraîné sur votre documentation, dans n’importe quelle application de votre choix.
* [Rechercher dans la documentation](/fr/api-reference/assistant/search) : Recherchez dans votre documentation.
* [Obtenir les retours des utilisateurs](/fr/api-reference/analytics/feedback) : Exportez les retours des utilisateurs depuis votre documentation.
* [Obtenir les conversations de l’Assistant](/fr/api-reference/analytics/assistant-conversations) : Exportez l’historique des conversations de l’Assistant IA.
<div id="common-use-cases">
### Cas d’usage courants
</div>
* **Déploiements automatisés** : Déclenchez les mises à jour du site à intervalles définis ou lors d’événements spécifiques avec [Trigger update](/fr/api-reference/update/trigger) et [Get update status](/fr/api-reference/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-reference/update/trigger).
* **Intégrations personnalisées** : Intégrez l’Assistant IA dans votre produit, votre portail d’assistance ou vos outils internes avec [Generate assistant message](/fr/api-reference/assistant/create-assistant-message) et [Search documentation](/fr/api-reference/assistant/search).
* **Édition automatisée** : Utilisez des tâches d’agent pour mettre à jour la documentation de manière programmatique et à grande échelle avec [Create agent job](/fr/api-reference/agent/create-agent-job), [Get agent job](/fr/api-reference/agent/get-agent-job), et [Get all agent jobs](/fr/api-reference/agent/get-all-jobs).
* **Export Analytics** : Exportez les feedbacks utilisateurs et les conversations de l’Assistant pour une analyse externe avec [Get user feedback](/fr/api-reference/analytics/feedback) et [Get assistant conversations](/fr/api-reference/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-reference/update/trigger), [obtenir l’état de la mise à jour](/fr/api-reference/update/status), [créer une tâche d’agent](/fr/api-reference/agent/create-agent-job), [obtenir une tâche d’agent](/fr/api-reference/agent/get-agent-job), [obtenir toutes les tâches d’agent](/fr/api-reference/agent/get-all-jobs), [obtenir les retours utilisateurs](/fr/api-reference/analytics/feedback) et [obtenir les conversations de l’Assistant](/fr/api-reference/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-reference/assistant/create-assistant-message) et [Rechercher dans la documentation](/fr/api-reference/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>