--- title: "Ask Eddy AI API" slug: "ask-eddy-ai-api" updated: 2026-06-18T08:34:05Z published: 2026-06-18T08:34:05Z 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 Die **Eddy AI Public API** ermöglicht es Ihnen, die unterstützende Suche von Eddy AI direkt in Ihre eigene Plattform oder Ihren Dienst einzubetten, sodass Nutzer Ihre Wissensdatenbank absuchen können, ohne Ihre Dokumentationsseite besuchen zu müssen. Sie rufen den API-Endpunkt mit einer Aufforderung auf und erhalten eine KI-generierte Antwort, die aus den Inhalten Ihrer Wissensdatenbank stammt. Das gibt Ihnen die volle Kontrolle über die Suchoberfläche – einschließlich ihres Aussehens, ihres Erscheinens und ihres Verhaltens innerhalb Ihres Produkts. Die API ist über den [Document360 API-Hub](https://apihub.document360.io/index.html) verfügbar. HINWEIS Eine vollständige Liste der von Eddy AI unterstützten Sprachen finden Sie unter [Multilingual Support for Eddy AI Search Suite](/help/docs/de/ai-search-suite#multilingual-support-for-eddy-ai-search-suite). --- ## Wann sollte man die Eddy AI Public API verwenden - **Eingebettete Suche in Ihrem Produkt** – Antworten der Wissensdatenbank werden in Ihrer Anwendungsoberfläche angezeigt, ohne Benutzer auf eine separate Dokumentationsseite umzuleiten. - **Individuelle Suchoberflächen** – erstellen Sie ein Sucherlebnis, das zum Farbschema, der Terminologie und dem Layout Ihrer Marke passt. - **Automatisierte Support-Workflows** – integrieren Sie Eddy AI in Chatbots, Ticketsysteme oder Onboarding-Flows, die Ihre Wissensdatenbank programmatisch abfragen. --- ## Bevor du anfängst - Die Eddy AI Public API muss in Ihren Projekteinstellungen aktiviert sein (siehe [Wie man die öffentliche API aktiviert).](https://docs.document360.com/docs/de/ask-eddy-ai-api#how-to-enable-the-public-api) - Du brauchst ein API-Token mit aktivierter POST-Methode (siehe [Wie man ein API-Token erstellt](https://docs.document360.com/docs/de/ask-eddy-ai-api#how-to-create-an-api-token) unten). - Der **KI-Umschalter für unterstützende Suche** benötigt, dass mindestens ein Kontrollkästchen (**öffentliche API** oder andere) ausgewählt bleibt – das Abwählen aller Kontrollkästchen schaltet automatisch den Umschalter aus. --- ## Wie man die öffentliche API aktiviert 1. Im Knowledge Base-Portal wählen Sie in der linken Navigationsleiste **Einstellungen** (⚙) aus. 2. Im linken Navigationsfenster gehen Sie zu **KI-Funktionen** > **Eddy AI.** 3. Erweitern Sie die **KI-Suchsuite** , Akkordeon. 4. Im Bereich **KI-Assistive Search** wählen Sie das **Kästchen Public API** aus. ![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) WARNUNG Wenn die öffentliche API nicht aktiviert ist, geben alle API-Aufrufe eine `500` (Servicefehler) oder `400` (API-Zugriff deaktiviert) Antwort zurück. Stellen Sie sicher, dass das Kontrollkästchen aktiviert ist, bevor Sie API-Aufrufe durchführen. --- ## Wie man einen API-Token erstellt Du brauchst ein API-Token, um Anfragen an der Eddy AI Public API zu authentifizieren. 1. Im Knowledge Base-Portal wählen Sie in der linken Navigationsleiste **Einstellungen** (⚙) aus. 2. Im linken Navigationsfenster gehen Sie zum **Knowledge Base-Portal** > **API-Tokens**. 3. Klicken Sie **auf API-Token erstellen**, geben Sie einen Token-Namen ein und setzen Sie die Methode auf **POST.** 4. Klicken Sie **auf Erstellen**, kopieren Sie das generierte API-Token und speichern Sie es sicher. --- ## Wie man die API testet Sie können die Eddy AI Public API auf zwei Arten testen – über die Document360 API-Dokumentation oder über den Swagger API-Hub. ### Test über API-Dokumentation 1. Gehe zur [Dokumentation der Document360 API](https://apidocs.document360.com/apidocs/perform-ai-assistive-search-ask-eddy-within-project-version). 2. Auf der rechten Seite der Seite wählen Sie den Abschnitt " **Probieren Sie es** ". 3. Im **Token-Feld** geben Sie Ihr API-Token ein. 4. Füllen Sie die **Körperfelder** aus: | Spielfeld | Beschreibung | | --- | --- | | **Prompt** | Die Frage oder Anfrage, die an Eddy AI gesendet werden soll | | **Versions-ID** | Die ID Ihrer Projektversion Ihrer Knowledge Base | | **Sprachcode** | Der Sprachcode für die Abfrage (z. B. `en`) | 1. Klicke auf **Try it und sieh die Antwort.** Die KI-generierte Antwort erscheint unten. ![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 mit Swagger 1. Geh zum [Swagger API-Hub.](https://apihub.document360.io/index.html) Die Ask Eddy AI API ist unter **Projektversionen** aufgeführt. 2. Oben rechts klicken Sie **auf Autorisieren**. 3. Im **Panel Verfügbare Autorisierungen** fügen Sie Ihr API-Token ein und klicken Sie **auf Autorisieren**. 4. Navigiere zu **Projektversionen** > `/v2/ProjectVersions/ask-Eddy AI` und klicke **auf 'Mal probieren**'. Das Standardanforderungsfeld erscheint mit folgenden Feldern zum Ausfüllen: | Spielfeld | Beschreibung | | --- | --- | | **Prompt** | Die Frage oder Anfrage, die an Eddy AI gesendet werden soll | | **Versions-ID** | Holen Sie dies vom Endpunkt ab `/v2/ProjectVersions` | | **Sprachcode** | Der Sprachcode für die Abfrage | Um Ihre Versions-ID abzurufen, rufen Sie zuerst den `/v2/ProjectVersions` Endpunkt auf: ![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. Klicken Sie **auf Ausführen**. Eine erfolgreiche Antwort enthält die KI-generierte Antwort und Details zum Quellenartikel. ![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) HINWEIS Wenn Sie in Swagger einen Fehler "Service nicht verfügbar" erhalten, überprüfen Sie, dass das **Kästchen Public API** in den **Einstellungen** > **KI-Funktionen** > **Eddy AI** > **AI-Suchsystem** aktiviert ist. --- ## Best Practices - **Speichern Sie API-Token sicher** – behandeln Sie Ihr API-Token als Geheimnis. Stellen Sie es nicht in clientseitigen Code oder öffentlichen Repositorien bereit. Rotiere es, wenn es beeinträchtigt ist. - **Verwenden Sie den richtigen ID-Typ für Ihren Inhalt** – Standardartikel verwenden `articleID`, aber Seitenkategorie-Artikel erfordern `categoryID`. Mit der falschen ID werden Nullfelder in der Antwort zurückgegeben. Siehe die [FAQ](/docs/de/ask-eddy-ai-api#faq) für Details. - **Geben Sie den Sprachcode explizit an** – geben Sie immer den richtigen Sprachcode im Anforderungskörper weiter, damit Eddy AI die richtige Sprachversion Ihrer Wissensdatenbank durchsucht. - **Fehlerantworten behandeln – implementieren Sie Fehlerbehandlungen** für `400` (API-Zugriff deaktiviert) und `500` (Servicefehler) Antworten. Beide zeigen typischerweise an, dass das Kästchen für die öffentliche API nicht aktiviert ist. --- ## FAQ   **Warum geben Quellartikelfelder in der API-Antwort Null zurück?**               Dies geschieht, wenn Sie einen **Seitenkategorie-Artikel** mit einem Abfrage abfragen.`articleID` Für Seitenkategorieninhalte kehren die Felder , `article_title`, und `article_slug` zurück`article_id`, `null` da der Inhalt auf Kategorieebene und nicht auf Artikelebene ist. Verwenden Sie stattdessen die Version, `categoryID` um die richtigen Details abzurufen. Eine Pagecategory-API-Antwort sieht so aus:       ``` { ```           **Warum erhalte ich beim Aufrufen der API einen 400- oder 500-Fehler?**               Eine (API-Zugriff deaktiviert `400` ) oder `500` (Servicefehler) Antwort bedeutet, dass die öffentliche API in Ihrem Projekt nicht aktiviert ist. Gehen Sie zu **Einstellungen** > **KI-Funktionen** > **Eddy AI** > **AI-Suchsystem** und bestätigen Sie, dass das **Kästchen Public API** aktiviert ist.           **Kann die Dokumentation mit einem Drittanbieter-Tool oder einem Chatbot integriert werden?**               Ja, Sie können den Ask Eddy AI-Endpunkt nutzen, um Antworten aus der Dokumentation abzurufen und Antworten über das Drittanbieter-Tool oder den Chatbot bereitzustellen.