Ask Eddy AI API

De Eddy AI Public API stelt je in staat om de ondersteunende zoekopdracht van Eddy AI direct in je eigen platform of dienst te integreren, zodat gebruikers je kennisbank kunnen doorzoeken zonder je documentatiesite te bezoeken. Je roept het API-eindpunt aan met een prompt en ontvangt een AI-gegenereerd antwoord afkomstig uit de inhoud van je kennisbasis. Dit geeft je volledige controle over de zoekinterface — inclusief hoe deze eruitziet, waar hij verschijnt en hoe hij zich binnen je product gedraagt. De API is beschikbaar via de Document360 API-hub.

Wanneer de Eddy AI Public API te gebruiken

• Ingebedde zoekopdracht in je product — laat de antwoorden in de kennisbank zichtbaar worden binnen de gebruikersinterface van je applicatie, zonder gebruikers door te leiden naar een aparte documentatiesite.
• Aangepaste zoekinterfaces — bouw een zoekervaring die past bij het kleurenschema, de terminologie en de lay-out van uw merk.
• Geautomatiseerde ondersteuningsworkflows — integreer Eddy AI in chatbots, ticketsystemen of onboardingflows die je kennisbank programmatisch doorvragen.

Voordat je begint

• De Eddy AI Public API moet ingeschakeld zijn in je projectinstellingen (zie Hoe je de Public API inschakelt hieronder).
• Je hebt een API-token nodig met de POST-methode ingeschakeld (zie Hoe maak je een API-token hieronder).
• De AI-hulpzoekschakelaar vereist dat er minstens één afleveringsselectievakje (Public API of andere) geselecteerd blijft — het uitvinken van alle selectievakjes schakelt automatisch de schakelaar uit.

Hoe de publieke API in te schakelen

1. Selecteer in het Knowledge Base-portaal Instellingen (⚙) in de linker navigatiebalk.
2. Ga in het linker navigatiepaneel naar AI-functies > Eddy AI.
3. Breid de AI-zoeksuite uit als accordeon.
4. Selecteer in de sectie AI assistieve zoekopdrachten het selectievakje Public API .

Hoe maak je een API-token

Je hebt een API-token nodig om verzoeken te authenticeren naar de Eddy AI Public API.

1. Selecteer in het Knowledge Base-portaal Instellingen (⚙) in de linker navigatiebalk.
2. Ga in het linker navigatiepaneel naar het kennisbasisportaal > API Tokens.
3. Klik op Create API Token, voer een tokennaam in en stel de methode in op POST.
4. Klik op Aanmaken, kopieer vervolgens het gegenereerde API-token en sla het veilig op.

Hoe test je de API

Je kunt de Eddy AI Public API op twee manieren testen — via de document360 API-documentatie of via de Swagger API-hub.

Test via API-documentatie

1. Ga naar de document360 API-documentatie.
2. Selecteer aan de rechterkant van de pagina de sectie Probeer het .
3. Voer in het Token-veld je API-token in.
4. Vul de lichaamsvelden in:

5. Klik op Try it en zie de reactie. De door AI gegenereerde reactie verschijnt hieronder.

Test via Swagger

1. Ga naar de Swagger API-hub. De Ask Eddy AI API staat onder Projectversies.

2. Klik rechtsboven op Autoriseren.

3. In het paneel Beschikbare autorisaties plakt u uw API-token en klikt u op Autoriseren.

4. Ga naar Projectversies > /v2/ProjectVersions/ask-Eddy AI en klik op Probeer het uit.

   Het standaardaanvraagvakje verschijnt met de volgende velden om in te vullen:

Om je versie-ID op te halen, roep eerst het /v2/ProjectVersions eindpunt aan:

5. Klik op Uitvoeren. Een succesvolle reactie bevat het door AI gegenereerde antwoord en details van het bronartikel.

Best practices

• Bewaar API-tokens veilig — behandel je API-token als een geheim. Maak het niet beschikbaar in client-side code of openbare repositories. Roteer hem als hij beschadigd is.
• Gebruik het juiste ID-type voor je inhoud — standaardartikelen gebruiken articleID, maar paginacategorie-artikelen vereisen categoryID. Het gebruik van de verkeerde ID levert nullvelden terug in het antwoord. Zie de FAQ voor details.
• Specificeer de taalcode expliciet — geef altijd de juiste taalcode door in de request body om ervoor te zorgen dat Eddy AI zoekt in de juiste taalversie van je kennisbasis.
• Behandel foutantwoorden — implementeer foutafhandeling voor 400 (API-toegang uitgeschakeld) en 500 (servicefout) antwoorden. Beide geven meestal aan dat het selectievakje Public API niet is ingeschakeld.

FAQ

{
"category_id": "_categoryid",

"category_title": "Title",

"category_slug": "slug",

"version_name": "v1",

"version_slug": "v1",

"article_id": null,

"article_title": null,

"article_slug": null,

"version_display_name": null

}