Documentation Syncanix
Tout ce qu’il faut pour découvrir votre API, intégrer le widget de chat, connecter un client MCP et lancer un assistant IA qui réalise de vraies actions pour vos utilisateurs — hébergé dans l’UE, en six langues.
Introduction
- Qu’est-ce que Syncanix ?Syncanix transforme votre API existante en un assistant IA avec lequel vos utilisateurs peuvent dialoguer — intégré à votre application et accessible aux clients IA via MCP.
- Comment fonctionne SyncanixD’une seule commande de découverte à un assistant opérationnel : comment le catalogue de capacités relie la CLI, le widget, la surface de chat et le serveur MCP.
- Vue d’ensemble de l’architectureComment Syncanix relie vos utilisateurs, votre API et l’IA — et où tout cela s’exécute.
- Langues et RTLSyncanix fonctionne dans six langues d’origine, avec une prise en charge complète de droite à gauche pour l’arabe et l’hébreu.
- GlossaireTermes clés utilisés dans la documentation de Syncanix.
Prise en main
Concepts de base
- Le catalogue de capacitésLa liste structurée de ce que votre API sait faire — découverte une fois, rédigée par vous et lue par toutes les surfaces.
- Le navigateur est le gardienLe modèle de sécurité de Syncanix en une idée : l’IA ne détient jamais les identifiants de vos utilisateurs.
- Identité et authentificationSyncanix utilise votre fournisseur d’identité existant — il ne devient jamais le coffre à mots de passe de vos utilisateurs.
- Confirmation des actions et risqueComment Syncanix décide de ce qui s’exécute automatiquement et de ce qui nécessite un oui humain.
- Modes de renduComment l’assistant affiche les résultats — composants intégrés, vos propres composants, ou diriger l’utilisateur vers la bonne page.
- Fiabilité et routage des modèlesComment Syncanix continue de répondre : plusieurs fournisseurs de modèles, vos propres clés et un routage dans l’UE.
- Mémoire et connaissancesCe dont l’assistant se souvient d’une session à l’autre, et les connaissances qu’il exploite pour répondre.
CLI
- La CLI SyncanixDécouvrez votre API et gérez votre catalogue en ligne de commande — sans installation.
- syncanix initDécouvrez votre API, construisez le catalogue de capacités et téléversez-le — avec un enrichissement par IA soumis à consentement.
- Plus de commandes de la CLIConnectez-vous, importez un schéma, lancez l’environnement local, diagnostiquez, enregistrez un serveur MCP externe et appliquez des surcouches de catalogue.
- Fichiers de configurationLes fichiers que la CLI lit et écrit : règles d’exclusion, configuration de la CLI, le catalogue, votre enregistrement de consentement, les identifiants et la surcouche de catalogue.
- Variables d’environnement et codes de sortieLes variables d’environnement que la CLI lit et les codes de sortie qu’elle renvoie.
- Prise en charge des frameworksLes langages et frameworks que la CLI de découverte peut lire automatiquement — et que faire quand le vôtre n’en fait pas partie.
Guides par framework
- Syncanix avec ExpressRendez une API Express prête pour les agents : ce que lit la découverte, comment la lancer et comment mettre en service la surface de chat et le serveur MCP.
- Syncanix avec NestJSRendez une API NestJS prête pour les agents : ce que lit la découverte, comment la lancer et comment mettre en service la surface de chat et le serveur MCP.
- Syncanix avec Next.jsRendez une application Next.js prête pour les agents : ce que lit la découverte, comment la lancer et comment mettre en service la surface de chat et le serveur MCP.
- Syncanix avec FastifyRendez une API Fastify prête pour les agents : ce que lit la découverte, comment la lancer et comment mettre en service la surface de chat et le serveur MCP.
- Syncanix avec FastAPIRendez un service FastAPI prêt pour les agents : ce que lit la découverte, comment la lancer et comment mettre en service la surface de chat et le serveur MCP.
- Syncanix avec DjangoRendez un projet Django prêt pour les agents : ce que lit la découverte, comment la lancer et comment mettre en service la surface de chat et le serveur MCP.
- Syncanix avec RailsRendez une API Rails prête pour les agents : ce que lit la découverte, comment la lancer et comment mettre en service la surface de chat et le serveur MCP.
- Syncanix avec LaravelRendez une API Laravel prête pour les agents : ce que lit la découverte, comment la lancer et comment mettre en service la surface de chat et le serveur MCP.
Tableau de bord
- Le tableau de bordLà où vous configurez votre espace de travail — le catalogue, la personnalité, les connaissances, le design, l’équipe et la facturation — au même endroit.
- Catalogue et capacitésParcourez les capacités découvertes et affinez chacune — sa description, ses autorisations, son risque, et plus.
- Points de terminaison personnalisés et disponibilité des outilsAjoutez des capacités que l’assistant peut appeler au-delà de vos routes découvertes, et contrôlez à quels utilisateurs chaque outil est proposé.
- Prompts et personnalitéDonnez à l’assistant une voix, un prompt système et un comportement clair de repli et de refus.
- Connaissances et documentsConnectez des sources de contenu pour que l’assistant puisse répondre à partir de votre documentation, et réglez ce qu’il récupère.
- Design et le Studio de Design du WidgetHabillez le widget aux couleurs de votre marque — tokens de thème, composants et le studio de design par organisation.
- Supervision, coût et auditVoyez les performances de l’assistant, ce qu’il coûte, et un enregistrement complet de ce qui s’est passé.
- Environnements et promotionConfigurez en toute sécurité en développement, puis promouvez en production derrière une étape d’évaluation.
- Équipe et rôlesInvitez votre équipe et donnez à chacun le bon niveau d’accès avec cinq rôles clairs.
- ParamètresClés, origines, vos propres clés de modèle, fédération d’identité, limites, facturation et remises.
Widget
- Le widgetIntégrez le widget de chat Syncanix dans votre application avec une seule balise de script — isolé, différé et aux couleurs de votre marque.
- Configuration du widgetConfigurez le widget avec des attributs data-* sur la balise de script.
- API d’exécution du widgetPilotez le widget depuis JavaScript via l’objet window.syncanix.
- Thématiser le widgetLe widget s’accorde à votre marque automatiquement, avec un contrôle total quand vous le voulez.
- Tailles et modesLe widget existe en cinq tailles et deux modes de disposition — choisissez ce qui convient à chaque endroit où vous l’utilisez.
- L’expérience de chatCe que voient vos utilisateurs dans une conversation — réponses en streaming, suggestions, cartes d’action, mentions et plus.
- Le SDK headlessConstruisez une interface de chat entièrement sur mesure au-dessus de Syncanix, sans monter le widget.
- Accessibilité et RTLLe widget respecte WCAG 2.1 AA et se dispose correctement dans les langues de droite à gauche.
Serveur MCP
- Le serveur MCPChaque espace de travail dispose de son propre serveur MCP, pour que des clients IA comme Claude Desktop, Cursor et ChatGPT atteignent vos capacités.
- Connecter un clientConnectez Claude Desktop, Cursor, ChatGPT et d’autres clients MCP à votre espace de travail.
- Comment fonctionne la connexion MCPLes clients MCP s’authentifient avec OAuth 2.1, fédéré à votre fournisseur d’identité — Syncanix ne conserve jamais les identifiants de vos utilisateurs.
- Outils et exécutionCe que le serveur MCP expose, comment les outils à risque sont marqués, et comment les appels s’exécutent réellement.
- Limites et points de terminaison MCPLes limites de session et les points de terminaison OAuth et de transport que le serveur MCP expose.
Authentification et accès
- Authentification et accèsComment les personnes se connectent à Syncanix — votre équipe au tableau de bord, vos propres utilisateurs au chat — ainsi que les clés, les fournisseurs d’identité et les garde-fous qui les relient.
- Connexion et espaces de travailComment vous et votre équipe vous connectez au tableau de bord Syncanix, et comment les espaces de travail séparent proprement le travail de chaque compte.
- Authentifier vos utilisateursLes quatre façons dont le widget peut authentifier vos propres utilisateurs finaux, et comment choisir celle qui convient à votre stack.
- Connecter un fournisseur d’identitéConnectez Auth0, Clerk, Amazon Cognito ou WorkOS dans le tableau de bord pour que Syncanix puisse authentifier vos utilisateurs finaux via le fournisseur que vous utilisez déjà.
- Clés d’APICréez, affichez et révoquez les deux types de clés émises par Syncanix — une clé secrète pour la CLI et MCP, et une clé publiable pour le widget intégré.
- Renforcement et sûreté des actionsComment Syncanix classe chaque action comme lecture, écriture ou destructrice — et les contrôles de confirmation, de revérification et d’annulation qui protègent chacune.
Facturation et forfaits
- Facturation et forfaitsComment Syncanix facture : des forfaits par espace de travail, une mesure à l’utilisateur final, des abonnements, l’usage de votre propre clé de modèle et les limites qui rendent la consommation prévisible.
- ForfaitsLes cinq forfaits Syncanix — Dev, Starter, Growth, Scale et Enterprise — ainsi que les essais, la facturation annuelle et les remises pour les associations, l’éducation et l’open source.
- Usage et mesureComment Syncanix mesure l’usage avec les utilisateurs finaux actifs mensuels (MAEU), comment le décompte fonctionne, ce qui se passe à votre limite et où le suivre.
- Gérer votre abonnementDémarrez, modifiez ou résiliez un forfait Syncanix, gérez votre moyen de paiement via le portail de facturation Paddle et retrouvez vos factures et reçus.
- Apportez votre propre clé (BYOK)Utilisez votre propre clé Anthropic ou OpenAI pour que l’usage du modèle soit facturé directement par votre fournisseur, sans majoration de Syncanix. Les clés sont en écriture seule et chiffrées au repos.
- Limites de débit et plafonds de dépenseLes garde-fous qui rendent l’usage de Syncanix prévisible : des limites de débit de la plateforme qui protègent la stabilité, et des plafonds de dépense que vous configurez pour rester dans votre budget.
Confiance, confidentialité et conformité
- Confiance, confidentialité et conformitéComment Syncanix protège vos données et celles de vos utilisateurs finaux : résidence des données dans l’UE, isolation entre locataires, ce que nous traitons et conservons, vos droits sur les données, notre programme de conformité et la transparence de l’IA.
- Résidence des données et sécuritéSyncanix s’exécute entièrement dans AWS eu-central-1 (Francfort), isole les données de chaque client sur quatre couches et chiffre les données en transit et au repos.
- Traitement et conservation des donnéesQuelles données Syncanix traite, comment la rétention zéro donnée (ZDR) fonctionne avec les fournisseurs de modèles, ce que la CLI de découverte envoie et combien de temps les données sont conservées.
- Confidentialité et vos droitsComment la mémoire de l’assistant est contrôlée, comment les données personnelles sont gérées et comment vous et vos utilisateurs finaux pouvez exercer les droits RGPD et CCPA via le formulaire de demande de données.
- Conformité et sous-traitantsLe programme de conformité de Syncanix : prise en charge du RGPD et de la CCPA avec un DPA disponible, SOC 2 et ISO 27001 en cours, et les sous-traitants sur lesquels nous nous appuyons.
- Transparence de l’IAComment Syncanix divulgue l’usage de l’IA aux utilisateurs finaux dans toutes les langues, quels modèles font fonctionner l’assistant et comment les réponses sont fondées sur votre contenu.
Guides
- GuidesDes tutoriels orientés tâches qui combinent la documentation de référence en travaux complets : lancer le widget, connecter un client IA, fonder les réponses, agir pour un utilisateur et passer en production.
- Ajoutez le widget de chat à votre sitePassez de votre code à un widget de chat en direct : découvrez votre API avec la CLI, examinez le catalogue, concevez le widget et intégrez l’extrait.
- Connectez un client IA à votre espace de travailConnectez Claude Desktop, Cursor ou ChatGPT à votre serveur MCP Syncanix pour qu’un client IA puisse utiliser votre API en votre nom.
- Fondez les réponses sur votre contenuAjoutez votre documentation et votre contenu pour que l’assistant réponde à partir de votre matériel au lieu de deviner, et vérifiez que cela fonctionne.
- Laissez l’assistant agir pour un utilisateur connectéPermettez à l’assistant d’effectuer des actions authentifiées au nom d’un utilisateur final connecté, cantonnées à ses autorisations, avec confirmation avant les actions sensibles.
- Gardez votre catalogue à jourRelancez la découverte quand votre API change, intégrez-la à la CI, et laissez la détection de dérive à l’exécution attraper ce qui passe entre les mailles.
- Export et effacement des donnéesComment fonctionnent les demandes des personnes concernées avec Syncanix — soumettre des demandes d’accès, d’export et d’effacement, les délais de réponse, et qui fait quoi.
- Passez en productionFaites passer votre assistant du test au direct : basculez vers l’environnement de production, générez des clés de production, définissez les origines autorisées, choisissez un forfait et activez les garde-fous.
- DépannageDes solutions par symptôme pour les problèmes que nous voyons réellement : un widget bloqué, une première requête lente, des ratés de détection, des échecs d’enrichissement et des soucis de connexion.
Référence
- RéférenceUne référence consolidée : faits rapides, formats de clés et d’identifiants, limites et valeurs par défaut de la plateforme, et renvois vers la référence de la CLI, la référence MCP, la prise en charge des frameworks et le glossaire.
- Clés, jetons et identifiantsUne référence consolidée des formats d’identifiants et de justificatifs utilisés dans Syncanix : clés d’API secrètes et publiables, jetons de connexion MCP et environnements.
- Limites et valeurs par défautUne référence unique pour les faits transversaux de la plateforme : région des données, conservation des journaux, réponses de limite de débit, l’unité de mesure, plafonds de dépense et langues prises en charge.
- Référence de l’API à l’exécutionLes contrats côté client à l’exécution : l’en-tête d’intention signé que votre backend vérifie, le contrat agir-en-tant-qu’utilisateur qu’il observe, et la forme des données du witness.