Komplett referensdokumentation för alla Knowledge Base-plattformens API:er.
Använd API-referensen när du vet vilken operation du vill implementera och behöver den aktuella slutpunkten, parametrar, begäran- och svarsscheman samt statusinformation.
Öppna API-referensen
Använd Swagger-referensen som den auktoritativa källan för aktuella slutpunktsdefinitioner och implementeringsdetaljer.
Vad du kan hitta i API-referensen
API-referensen tillhandahåller implementeringsdetaljer för tillgängliga operationer, inklusive:
- HTTP-metoder och slutpunktssökvägar.
- Parametrar för begäran.
- Begäran- och svarsscheman.
- Svars- och statusinformation.
Tillgängliga API:er täcker funktionsområden som:
- Samlingar och samlingsåtkomst.
- Dokument och dokumentbearbetning.
- AI-inferens.
- Bilagor.
- Dokumenttaggar.
- Användare och organisationer.
- Återkoppling.
- Inställningar.
- Analytics och rapportering.
- Botintegrationer.
Använd Kom igång med Knowledge Base API om du behöver en introduktion till API-resursmodellen, dokumentbearbetningslivscykeln, inferensbeteende eller typiskt begärandeflöde.
Felsök API-begäranden
API-svar innehåller ett X-Request-ID svarshuvud som identifierar begäran mellan Knowledge Base-tjänsterna.
Fånga X-Request-ID när du felsöker en misslyckad begäran eller kontaktar Support.Behåll även HTTP-status, svarsdetaljer, slutpunkt och ungefärlig tid för begäran.
