Volledige naslagdocumentatie voor alle Knowledge Base platform-API's.
Gebruik de API-naslaggids wanneer je weet welke bewerking je wilt implementeren en het huidige eindpunt, parameters, verzoek- en reactieschema's en statusinformatie nodig hebt.
API-naslaggids openen
Gebruik de Swagger-naslaggids als de gezaghebbende bron voor huidige eindpuntdefinities en implementatiegegevens.
Wat je kunt vinden in de API-naslaggids
De API-naslaggids biedt implementatiegegevens voor beschikbare bewerkingen, waaronder:
- HTTP-methoden en eindpuntpaden.
- Verzoekparameters.
- Verzoek- en reactieschema's.
- Reactie- en statusinformatie.
Beschikbare API's dekken functionele gebieden zoals:
- Verzamelingen en toegang tot verzamelingen.
- Documenten en documentverwerking.
- AI-inferentie.
- Bijlagen.
- Documenttags.
- Gebruikers en organisaties.
- Feedback.
- Instellingen.
- Analytics en rapportage.
- Bot-integraties.
Gebruik Aan de slag met de Knowledge Base API als je een inleiding nodig hebt tot het API-resourcemodel, de levenscyclus van documentverwerking, het inferentiegedrag of de typische aanvraagstroom.
Problemen met API-verzoeken oplossen
API-reacties bevatten een X-Request-ID reactiekoptekst die het verzoek identificeert binnen Knowledge Base services.
Leg de X-Request-ID vast bij het oplossen van problemen met een mislukt verzoek of bij contact met ondersteuning.Behoud ook de HTTP-status, reactiedetails, eindpunt en geschatte tijd van de aanvraag.