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.

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 ci-dessous).
• Vous avez besoin d’un jeton API avec la méthode POST activée (voir Comment créer un jeton API 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 .

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.
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 :

5. Cliquez sur Essayer et voir la réponse. La réponse générée par l’IA apparaît ci-dessous.

Test via Swagger

1. Allez sur le hub de l’API Swagger. 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 :

Pour récupérer votre ID de version, appelez d’abord le /v2/ProjectVersions point de terminaison :

5. 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.

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 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

{
"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

}