Täydellinen viitedokumentaatio kaikista Knowledge Base -alustan sovellusliittymistä.
Käytä API-viitettä silloin, kun tiedät minkä toiminnon haluat toteuttaa ja tarvitset nykyisen päätepisteen, parametrit, pyyntö- ja vastausskeemat sekä tilatiedot.
Avaa API-viite
Käytä Swagger-viitettä virallisena lähteenä nykyisille päätepistemääritelmille ja toteutustiedoille.
Mitä löydät API-viitteestä
API-viite tarjoaa toteutustietoja saatavilla oleville toiminnoille, mukaan lukien:
- HTTP-metodit ja päätepisteen polut.
- Pyyntöparametrit.
- Pyyntö- ja vastausskeemat.
- Vastaus- ja tilatiedot.
Saatavilla olevat API:t kattavat toiminnallisia alueita, kuten:
- Kokoelmat ja kokoelmien käyttöoikeudet.
- Asiakirjat ja asiakirjojen käsittely.
- Tekoälypäättely.
- Liitteet.
- Asiakirjatunnisteet.
- Käyttäjät ja organisaatiot.
- Palaute.
- Asetukset.
- Analytiikka ja raportointi.
- Bot-integraatiot.
Katso Aloita Knowledge Base -sovellusliittymän käyttö, jos tarvitset johdatuksen API-resurssimalliin, asiakirjojen käsittelyn elinkaareen, päättelykäyttäytymiseen tai tyypilliseen pyyntötyönkulkuun.
API-pyyntöjen vianmääritys
API-vastaukset sisältävät X-Request-ID-vastausotsikon, joka tunnistaa pyynnön Knowledge Base-palveluissa.
Tallenna X-Request-ID, kun selvität epäonnistunutta pyyntöä tai otat yhteyttä tukeen. Säilytä myös HTTP-tila, vastauksen tiedot, päätepiste ja pyynnön likimääräinen aika.
