Kompletna dokumentacja referencyjna dla wszystkich interfejsów API platformy Knowledge Base.
Z dokumentacji interfejsu API należy korzystać, gdy znana jest operacja do zaimplementowania i potrzebny jest bieżący punkt końcowy, parametry, schematy żądań i odpowiedzi oraz informacje o stanie.
Otwórz dokumentację referencyjną API
Dokumentacja Swagger jest miarodajnym źródłem bieżących definicji punktów końcowych i szczegółów implementacji.
Co można znaleźć w dokumentacji referencyjnej API
Dokumentacja referencyjna API zawiera szczegóły implementacji dostępnych operacji, w tym:
- Metody HTTP i ścieżki punktów końcowych.
- Parametry żądania.
- Schematy żądań i odpowiedzi.
- Informacje o odpowiedziach i stanie.
Dostępne interfejsy API obejmują obszary funkcjonalne, takie jak:
- Kolekcje i dostęp do kolekcji.
- Dokumenty i przetwarzanie dokumentów.
- Wnioskowanie SI.
- Załączniki.
- Tagi dokumentów.
- Użytkownicy i organizacje.
- Opinie.
- Ustawienia.
- Analytics i raportowanie.
- Integracje botów.
Skorzystaj z przewodnika Rozpocznij pracę z interfejsem API Knowledge Base, jeśli potrzebujesz wprowadzenia do modelu zasobów API, cyklu życia przetwarzania dokumentów, zachowania wnioskowania lub typowego przepływu żądań.
Rozwiązywanie problemów z żądaniami API
Odpowiedzi API zawierają nagłówek odpowiedzi X-Request-ID, który identyfikuje żądanie w usługach Knowledge Base.
Przechwyć X-Request-ID podczas rozwiązywania problemów z nieudanym żądaniem lub kontaktu z działem pomocy technicznej. Zachowaj również stan HTTP, szczegóły odpowiedzi, punkt końcowy i przybliżony czas żądania.
