--- title: "Ask Eddy AI API" slug: "ask-eddy-ai-api" description: "The Eddy Public API is an invaluable add-on designed to enhance the functionality and flexibility of our Eddy search feature." tags: ["Eddy", "API"] updated: 2026-06-18T09:09:18Z published: 2026-06-18T09:09:18Z canonical: "docs.document360.com/ask-eddy-ai-api" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.document360.com/llms.txt > Use this file to discover all available pages before exploring further. # 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](https://apihub.document360.io/index.html). OPMERKING Voor een volledige lijst van talen die door Eddy AI worden ondersteund, zie [Multilingual support for Eddy AI Search Suite](/help/docs/nl/ai-search-suite#multilingual-support-for-eddy-ai-search-suite). --- ## 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](https://docs.document360.com/docs/nl/ask-eddy-ai-api#how-to-enable-the-public-api) hieronder). - Je hebt een API-token nodig met de POST-methode ingeschakeld (zie [Hoe maak je een API-token](https://docs.document360.com/docs/nl/ask-eddy-ai-api#how-to-create-an-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** . ![Eddy AI settings page showing the AI assistive search section with the Public API checkbox selected.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/Screenshot-Eddy_ai_public_api.png) WAARSCHUWING Als de Public API niet is ingeschakeld, geven alle API-aanroepen een `500` (servicefout) of `400` (API-toegang uitgeschakeld) antwoord terug. Zorg ervoor dat het selectievakje is aangevinkt voordat je API-aanroepen doet. --- ## 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](https://apidocs.document360.com/apidocs/perform-ai-assistive-search-ask-eddy-within-project-version). 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: | Veld | Beschrijving | | --- | --- | | **Prompt** | De vraag of vraag om naar Eddy AI te sturen | | **Versie-ID** | De ID van je kennisbasisprojectversie | | **Taalcode** | De taalcode voor de query (bijv. `en`) | 1. Klik op **Try it en zie de reactie**. De door AI gegenereerde reactie verschijnt hieronder. ![Document360 API documentation showing the Try it section with Token, Prompt, Version ID, and Language code fields filled in.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/5_Screenshot-Ask_Eddy_in_API_Documentation.png) ### Test via Swagger 1. Ga naar de [Swagger API-hub.](https://apihub.document360.io/index.html) 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: | Veld | Beschrijving | | --- | --- | | **Prompt** | De vraag of vraag om naar Eddy AI te sturen | | **Versie-ID** | Haal dit op van het `/v2/ProjectVersions` eindpunt | | **Taalcode** | De taalcode voor de query | Om je versie-ID op te halen, roep eerst het `/v2/ProjectVersions` eindpunt aan: ![Swagger API hub showing the /v2/ProjectVersions endpoint response with the version ID highlighted.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/6_Screenshot-Updating_Getting_Project_version.png) 1. Klik **op Uitvoeren**. Een succesvolle reactie bevat het door AI gegenereerde antwoord en details van het bronartikel. ![Screen recording of the Swagger API hub — authorizing with an API token and executing the Ask Eddy AI endpoint.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/4_ScreenGIF-Using_Eddy_API_Token_in_Swagger.gif) OPMERKING Als je een "service niet beschikbaar"-foutmelding krijgt in Swagger, controleer dan of het **selectievakje Public API** is geselecteerd in **Instellingen** > **AI-functies** > **Eddy AI** > **AI-zoeksuite**. --- ## 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](/docs/nl/ask-eddy-ai-api#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   **Waarom geven de velden van bronartikelen null terug in het API-antwoord?**               Dit gebeurt wanneer je een **paginacategorie-artikel** raadpleegt met een `articleID`. Voor paginacategorie-inhoud keren de `article_id`, `article_title`, en velden `article_slug` terug `null` omdat de inhoud categorieniveau is, niet artikelniveau. Gebruik in plaats daarvan de `categoryID` juiste gegevens om de juiste gegevens op te halen. Een Pagecategory API-respons ziet er als volgt uit:       ``` { ```           **Waarom krijg ik een 400- of 500-fout wanneer ik de API aanroep?**               Een (API-toegang uitgeschakeld `400` ) of `500` (servicefout) reactie betekent dat de publieke API niet is ingeschakeld in je project. Ga naar **Instellingen** > **AI-functies** > **Eddy AI** > **AI-zoeksuite** en bevestig dat het **selectievakje voor de publieke API** is geselecteerd.           **Kan de documentatie worden geïntegreerd met een tool van derden of chatbot?**               Ja, je kunt het Ask Eddy AI-eindpunt gebruiken om antwoorden uit de documentatie op te halen en antwoorden te geven via de tool of chatbot van derden. ## Related - [Configureer AI-assistieve zoekopdracht](/configure-ai-assistive-search.md)