Documentation de référence complète pour toutes les API de la plateforme Knowledge Base.
Utilisez la référence de l’API lorsque vous connaissez l’opération dont vous avez besoin et que vous souhaitez implémenter le point d’entrée actuel, les paramètres, les schémas de demandes et de réponse, ainsi que les informations de statut.
Ouvrir la référence de l’API
Utilisez la référence Swagger comme source officielle pour les définitions de point d’entrée actuelles et les détails d’implémentation.
Ce que vous pouvez trouver dans la référence API
La référence API fournit les détails d’implémentation pour les opérations disponibles, notamment :
- Les méthodes HTTP et les chemins d’accès des points d’entrée.
- Les paramètres des demandes.
- Les schémas de demande et de réponse.
- Les informations de réponse et de statut.
Les API disponibles couvrent des domaines fonctionnels tels que :
- Les collections et l’accès aux collections.
- Les documents et le traitement des documents.
- Inférence IA
- Les pièces jointes.
- Les balises de document.
- Les utilisateurs et les organisations.
- Les commentaires.
- Paramètres.
- Les analyses et rapports.
- Intégrations de robots.
Consultez Commencer avec l’API Knowledge Base si vous avez besoin d’une introduction au modèle de ressource API, au cycle de vie des processus de documentation, au comportement d’inférence ou au flux de demande typique.
Résoudre les problèmes liés aux requêtes API
Les réponses API incluent un en-tête de réponse X-Request-ID qui identifie la demande à travers les services Knowledge Base.
Capturez le X-Request-ID lors du dépannage d’une demande ayant échoué ou lors d’un contact avec l’assistance. Conservez également le statut HTTP, les détails de réponse, le point d’entrée et l’heure approximative de la demande.
