--- title: "Ask Eddy AI API" slug: "ask-eddy-ai-api" updated: 2026-06-18T07:39:58Z published: 2026-06-18T07:39:58Z 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 **L’API publique d’Eddy** AI vous permet d’intégrer directement la recherche assistive d’Eddy AI dans votre propre plateforme ou service, permettant aux utilisateurs d’interroger votre base de connaissances sans avoir à consulter votre site de documentation. Vous appelez le point de terminaison de l’API avec une invite et recevez une réponse générée par l’IA tirée du contenu de votre base de connaissances. Cela vous donne un contrôle total sur l’interface de recherche — y compris son apparence, son emplacement et son comportement dans votre produit. L’API est disponible via le [hub API Document360](https://apihub.document360.io/index.html). NOTE Pour une liste complète des langues prises en charge par Eddy AI, voir [Support multilingue pour Eddy AI Search Suite](/help/docs/fr/ai-search-suite#multilingual-support-for-eddy-ai-search-suite). --- ## Quand utiliser l’API publique d’Eddy AI - **Recherche intégrée dans votre produit** — les réponses de la base de connaissances à l’intérieur de l’interface de votre application, sans rediriger les utilisateurs vers un site de documentation séparé. - **Interfaces de recherche personnalisées** — créez une expérience de recherche qui correspond au schéma de couleurs, à la terminologie et à la mise en page de votre marque. - **Flux de travail automatisés de support** — intégrez Eddy AI dans des chatbots, des systèmes de tickets ou des flux d’intégration qui interrogent votre base de connaissances de manière programmatique. --- ## Avant que tu commences - L’API publique Eddy AI doit être activée dans les paramètres de votre projet (voir [Comment activer l’API publique](https://docs.document360.com/docs/fr/ask-eddy-ai-api#how-to-enable-the-public-api) ci-dessous). - Vous avez besoin d’un jeton API avec la méthode POST activée (voir [Comment créer un jeton API](https://docs.document360.com/docs/fr/ask-eddy-ai-api#how-to-create-an-api-token) ci-dessous). - Le bouton **de recherche assistée par IA** nécessite qu’au moins une case de livraison (**API publique** ou autre) reste sélectionnée — décocher toutes les cases désactivera automatiquement le basculement. --- ## Comment activer l’API publique 1. Dans le portail de la Base de connaissances, sélectionnez **Paramètres** (⚙) dans la barre de navigation de gauche. 2. Dans le volet de navigation de gauche, allez dans **les fonctions IA** > **Eddy AI**. 3. Élargissez la **suite de recherche IA** accordéon. 4. Dans la section **recherche assistée par IA** , sélectionnez la case **à cocher pour l’API publique** . ![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) AVERTISSEMENT Si l’API publique n’est pas activée, tous les appels d’API rafficheront une `500` réponse (erreur de service) ou `400` (accès API désactivé). Assurez-vous que la case est cochée avant de passer à l’appel API. --- ## Comment créer un jeton API Vous avez besoin d’un jeton API pour authentifier les requêtes vers l’API publique d’Eddy AI. 1. Dans le portail de la Base de connaissances, sélectionnez **Paramètres** (⚙) dans la barre de navigation de gauche. 2. Dans le panneau de navigation de gauche, allez au **portail de la base de connaissances** > **Jetons API**. 3. **Cliquez sur Créer un jeton API**, saisissez un nom de jeton, puis définissez la méthode sur **POST**. 4. **Cliquez sur Créer**, puis copiez le jeton API généré et stockez-le en toute sécurité. --- ## Comment tester l’API Vous pouvez tester l’API publique Eddy AI de deux manières — via la documentation de l’API Document360 ou via le hub API Swagger. ### Tester via la documentation API 1. Va dans la [documentation de l’API Document360](https://apidocs.document360.com/apidocs/perform-ai-assistive-search-ask-eddy-within-project-version). 2. Sur le côté droit de la page, sélectionnez la section **Essayer** . 3. Dans le champ **Jeton** , saisissez votre jeton API. 4. Remplissez les champs **Corps** : | Terrain | Description | | --- | --- | | **Prompt** | La question ou requête à envoyer à Eddy AI | | **Version ID** | L’ID de la version de projet de votre base de connaissances | | **Code linguistique** | Le code du langage pour la requête (par exemple `en`) | 1. **Cliquez sur Essayer et voir la réponse**. La réponse générée par l’IA apparaît ci-dessous. ![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. Allez sur le [hub de l’API Swagger](https://apihub.document360.io/index.html). L’API IA Ask Eddy est listée sous **les versions du projet**. 2. Dans le coin supérieur droit, cliquez **sur Autorisé.** 3. Dans le panneau **Autorisations disponibles** , collez votre jeton API et cliquez **sur Autoriser**. 4. Naviguez vers **les versions du projet** > `/v2/ProjectVersions/ask-Eddy AI` et cliquez **sur Essayer**. La boîte de requête par défaut apparaît avec les champs suivants à compléter : | Terrain | Description | | --- | --- | | **Prompt** | La question ou requête à envoyer à Eddy AI | | **Version ID** | Récupérez cela depuis le `/v2/ProjectVersions` point de terminaison | | **Code linguistique** | Le code linguistique pour la requête | Pour récupérer votre ID de version, appelez d’abord le `/v2/ProjectVersions` point de terminaison : ![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. **Cliquez sur Exécuter**. Une réponse réussie contient la réponse générée par l’IA et les détails de l’article source. ![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) NOTE Si vous recevez une erreur « service indisponible » dans Swagger, vérifiez que la case **à cocher de l’API publique** est sélectionnée dans **Paramètres** > **fonctionnalités IA** > **suite de recherche Eddy AI** > AI. --- ## Meilleures pratiques - **Stockez les jetons API en toute sécurité** — considérez votre jeton API comme un secret. Ne l’exposez pas dans du code côté client ni dans des dépôts publics. Faites-le pivoter s’il est compromis. - **Utilisez le type d’ID correct pour votre contenu** — les articles standards utilisent `articleID`, mais les articles de catégorie de page exigent `categoryID`. Utiliser le mauvais ID renvoie des champs nuls dans la réponse. Voir la [FAQ](/docs/fr/ask-eddy-ai-api#faq) pour plus de détails. - **Spécifiez explicitement le code linguistique** — passez toujours le code de langue correct dans le corps de la requête afin de garantir qu’Eddy AI recherche la bonne version linguistique de votre base de connaissances. - **Gérer les réponses d’erreur** — implémenter la gestion des erreurs pour `400` les réponses (accès API désactivé) et `500` (erreur de service). Les deux indiquent généralement que la case à cocher de l’API publique n’est pas activée. --- ## FAQ   **Pourquoi les champs d’article source retournent-ils null dans la réponse de l’API ?**               Cela se produit lorsque vous interrogez un article **Pagecategory** en utilisant un `articleID`fichier . Pour le contenu Pagecategory, les `article_id`champs , `article_title`, et `article_slug` sont retournés `null` car le contenu est au niveau catégorie, et non au niveau article. Utilisez le `categoryID` Instead pour récupérer les bonnes informations. Une réponse API Pagecategory ressemble à ceci :       ``` { ```           **Pourquoi reçois-je une erreur 400 ou 500 lorsque j’appelle l’API ?**               Une `400` réponse (accès API désactivé) ou `500` (erreur de service) signifie que l’API publique n’est pas activée dans votre projet. Allez dans **Paramètres** > **fonctionnalités de l’IA** > **suite de recherche Eddy AI** > et vérifiez que la case **à cocher de l’API publique** est cochée.           **La documentation peut-elle être intégrée à un outil tiers ou à un chatbot ?**               Oui, vous pouvez utiliser le point de terminaison Ask Eddy AI pour récupérer les réponses de la documentation et fournir des réponses via l’outil tiers ou le chatbot.