Vollständige Referenzdokumentation aller APIs der Knowledgebase-Plattform.
Verwende die API-Referenz, wenn du die Operation kennst, die du implementieren möchtest, und den aktuellen Endpunkt, Parameter, Anfrage- und Antwort-Schemata sowie Statusinformationen benötigst.
API-Referenz öffnen
Verwende die Swagger-Referenz als maßgebliche Quelle für aktuelle Endpunkt-Definitionen und Implementierungsdetails.
Was du in der API-Referenz findest
Die API-Referenz bietet Implementierungsdetails für verfügbare Operationen, einschließlich:
- HTTP-Methoden und Endpunkt-Pfade.
- Anforderungsparameter.
- Anfrage- und Antwort-Schemata.
- Antwort- und Statusinformationen.
Verfügbare APIs decken Funktionsbereiche ab wie:
- Sammlungen und Sammlungszugriff.
- Dokumente und Dokumentenverarbeitung.
- KI-Inferenz.
- Anhänge.
- Dokumenttags.
- Benutzer und Organisationen.
- Feedback.
- Einstellungen.
- Analytics und Reporting.
- Bot-Integrationen.
Verwende Erste Schritte mit der Knowledgebase-API, wenn du eine Einführung in das API-Ressourcenmodell, den Dokumentenverarbeitungslebenszyklus, das Inferenzverhalten oder den typischen Anfragefluss benötigst.
Fehlerbehebung bei API-Anfragen
API-Antworten enthalten einen X-Request-ID-Antwortheader, der die Anfrage in den Knowledgebase-Diensten identifiziert.
Erfasse die X-Request-ID bei der Fehlerbehebung einer fehlgeschlagenen Anfrage oder beim Kontaktieren des Supports. Notiere außerdem den HTTP-Status, Antwortdetails, Endpunkt und die ungefähre Zeit der Anfrage.
