L’API REST nécessite une offre Pro ou Enterprise.
Endpoints
- Trigger update: Déclenchez une mise à jour de votre site quand vous le souhaitez.
- Get update status: Récupérez le statut d’une mise à jour et d’autres détails sur votre documentation.
- Trigger preview deployment: Créez ou mettez à jour un déploiement de prévisualisation pour une branche spécifique.
- Trigger automation: Exécute une automatisation planifiée à la demande.
- Detect AI-sounding prose : 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: Créez une tâche d’agent pour modifier automatiquement votre documentation.
- Get agent job: Récupérez les détails et le statut d’une tâche d’agent spécifique.
- Send follow-up message: Envoyez un message de suivi à une tâche d’agent existante.
- Create assistant message: Intégrez l’Assistant, entraîné sur votre documentation, dans n’importe quelle application de votre choix.
- Search documentation: Effectuez une recherche dans votre documentation.
- Get page content: Récupérez le contenu textuel complet d’une page de documentation.
- Get user feedback: Exportez les retours utilisateurs issus de votre documentation.
- Get assistant conversations: Exportez l’historique des conversations de l’Assistant IA.
- Get 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 et Get 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.
- 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.
- 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.
- Intégrations de l’Assistant : Intégrez l’Assistant IA à votre produit, portail d’assistance ou outils internes avec Create assistant message.
- Récupération de la documentation : Recherchez et récupérez la documentation pour des expériences de recherche personnalisées avec Search documentation et 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, Get agent job, et Send follow-up 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, Get assistant conversations et Get assistant caller stats.
URL de base
Authentification
Clé d’API administrateur
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
mint_dsc_.
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.