Fullstendig referansedokumentasjon for alle Knowledge Base-plattform-API-er.
Bruk API-referansen når du vet hvilken operasjon du vil implementere og trenger gjeldende endepunkt, parametere, forespørsel- og responsskjemaer, og statusinformasjon.
Åpne API-referansen
Bruk Swagger-referansen som den autoritative kilden for gjeldende endepunktdefinisjoner og implementeringsdetaljer.
Hva du kan finne i API-referansen
API-referansen gir implementeringsdetaljer for tilgjengelige operasjoner, inkludert:
- HTTP-metoder og endepunktstier.
- Forespørselsparametere.
- Forespørsel- og responsskjemaer.
- Respons- og statusinformasjon.
Tilgjengelige API-er dekker funksjonelle områder som:
- Samlinger og samlingstilgang.
- Dokumenter og dokumentbehandling.
- KI-inferens.
- Vedlegg.
- Dokumentkoder.
- Brukere og organisasjoner.
- Tilbakemelding.
- Innstillinger.
- Analytics og rapportering.
- Botintegrasjoner.
Bruk Kom i gang med Knowledge Base API hvis du trenger en introduksjon til API-ressursmodellen, dokumentbehandlingslivssyklusen, inferensatferd eller typisk forespørselsflyt.
Feilsøk API-forespørsler
API-responser inkluderer en X-Request-ID-responsheader som identifiserer forespørselen på tvers av Knowledge Base-tjenester.
Fang opp X-Request-ID når du feilsøker en mislykket forespørsel eller kontakter kundestøtte.Behold også HTTP-statusen, svardataene, endepunktet og omtrentlig tidspunkt for forespørselen.
