Syncanix-Dokumentation
Alles, was Sie brauchen, um Ihre API zu erkennen, das Chat-Widget einzubinden, einen MCP-Client zu verbinden und einen KI-Assistenten auszuliefern, der echte Aktionen für Ihre Nutzer ausführt – gehostet in der EU, in sechs Sprachen.
Einführung
- Was ist Syncanix?Syncanix macht aus Ihrer bestehenden API einen KI-Assistenten, mit dem Ihre Nutzer sprechen können – eingebettet in Ihre App und für KI-Clients über MCP erreichbar.
- So funktioniert SyncanixVon einem einzigen Discovery-Befehl zum laufenden Assistenten: wie der Fähigkeitskatalog die CLI, das Widget, die Chat-Oberfläche und den MCP-Server verbindet.
- ArchitekturüberblickWie Syncanix Ihre Nutzer, Ihre API und die KI verbindet – und wo alles läuft.
- Sprachen & RTLSyncanix funktioniert von Haus aus in sechs Sprachen, mit voller Rechts-nach-links-Unterstützung für Arabisch und Hebräisch.
- GlossarSchlüsselbegriffe aus der Syncanix-Dokumentation.
Erste Schritte
Grundkonzepte
- Der FähigkeitskatalogDie strukturierte Liste dessen, was Ihre API kann – einmal erkannt, von Ihnen verfasst und von jeder Oberfläche gelesen.
- Der Browser ist das TorDas Sicherheitsmodell von Syncanix in einer Idee: Die KI hält niemals die Anmeldedaten Ihrer Nutzer.
- Identität & AuthentifizierungSyncanix nutzt Ihren bestehenden Identitätsanbieter – es wird nie zum Passwortspeicher Ihrer Nutzer.
- Aktionsbestätigung & RisikoWie Syncanix entscheidet, was automatisch läuft und was ein menschliches Ja braucht.
- DarstellungsartenWie der Assistent Ergebnisse zeigt – eingebaute Komponenten, eigene Komponenten oder den Nutzer auf die richtige Seite führen.
- Zuverlässigkeit & Modell-RoutingWie Syncanix weiter antwortet: mehrere Modellanbieter, eigene Schlüssel und EU-Routing.
- Gedächtnis & WissenWoran sich der Assistent über Sitzungen hinweg erinnert und auf welches Wissen er beim Antworten zurückgreift.
CLI
- Die Syncanix-CLIErkennen Sie Ihre API und verwalten Sie Ihren Katalog auf der Kommandozeile – ohne Installation.
- syncanix initErkennen Sie Ihre API, bauen Sie den Fähigkeitskatalog und laden Sie ihn hoch – mit einwilligungsgebundener KI-Anreicherung.
- Weitere CLI-BefehleAnmelden, ein Schema importieren, die lokale Umgebung starten, diagnostizieren, einen externen MCP-Server registrieren und Katalog-Overlays anwenden.
- KonfigurationsdateienDie Dateien, die die CLI liest und schreibt: Ignore-Regeln, CLI-Konfiguration, der Katalog, Ihr Einwilligungsnachweis, Anmeldedaten und das Katalog-Overlay.
- Umgebungsvariablen & Exit-CodesDie Umgebungsvariablen, die die CLI liest, und die Exit-Codes, die sie zurückgibt.
- Framework-UnterstützungDie Sprachen und Frameworks, die die Discovery-CLI automatisch lesen kann — und was zu tun ist, wenn Ihres nicht dabei ist.
Framework-Leitfäden
- Syncanix mit ExpressMachen Sie eine Express-API agent-ready: was die Discovery liest, wie Sie sie ausführen und wie Sie Chat-Oberfläche und MCP-Server ausliefern.
- Syncanix mit NestJSMachen Sie eine NestJS-API agent-ready: was die Discovery liest, wie Sie sie ausführen und wie Sie Chat-Oberfläche und MCP-Server ausliefern.
- Syncanix mit Next.jsMachen Sie eine Next.js-App agent-ready: was die Discovery liest, wie Sie sie ausführen und wie Sie Chat-Oberfläche und MCP-Server ausliefern.
- Syncanix mit FastifyMachen Sie eine Fastify-API agent-ready: was die Discovery liest, wie Sie sie ausführen und wie Sie Chat-Oberfläche und MCP-Server ausliefern.
- Syncanix mit FastAPIMachen Sie einen FastAPI-Service agent-ready: was die Discovery liest, wie Sie sie ausführen und wie Sie Chat-Oberfläche und MCP-Server ausliefern.
- Syncanix mit DjangoMachen Sie ein Django-Projekt agent-ready: was die Discovery liest, wie Sie sie ausführen und wie Sie Chat-Oberfläche und MCP-Server ausliefern.
- Syncanix mit RailsMachen Sie eine Rails-API agent-ready: was die Discovery liest, wie Sie sie ausführen und wie Sie Chat-Oberfläche und MCP-Server ausliefern.
- Syncanix mit LaravelMachen Sie eine Laravel-API agent-ready: was die Discovery liest, wie Sie sie ausführen und wie Sie Chat-Oberfläche und MCP-Server ausliefern.
Dashboard
- Das DashboardHier konfigurieren Sie Ihren Arbeitsbereich — Katalog, Persönlichkeit, Wissen, Design, Team und Abrechnung — an einem Ort.
- Katalog & FähigkeitenDurchsuchen Sie die erkannten Fähigkeiten und verfeinern Sie jede — Beschreibung, Berechtigungen, Risiko und mehr.
- Eigene Endpunkte & WerkzeugverfügbarkeitFügen Sie Fähigkeiten hinzu, die der Assistent über Ihre erkannten Routen hinaus aufrufen kann, und steuern Sie, welchen Nutzern jedes Werkzeug angeboten wird.
- Prompts & PersönlichkeitGeben Sie dem Assistenten eine Stimme, einen System-Prompt und klares Rückfall- und Ablehnungsverhalten.
- Wissen & DokumenteBinden Sie Inhaltsquellen an, damit der Assistent aus Ihrer Dokumentation antworten kann, und stellen Sie ein, was er abruft.
- Design & das Widget-Design-StudioGestalten Sie das Widget passend zu Ihrer Marke — Theme-Tokens, Komponenten und das Design-Studio pro Organisation.
- Überwachung, Kosten & AuditSehen Sie, wie der Assistent abschneidet, was er kostet, und ein vollständiges Protokoll des Geschehenen.
- Umgebungen & ÜberführungRichten Sie alles gefahrlos in der Entwicklung ein und überführen Sie es dann hinter einer Bewertungsstufe in die Produktion.
- Team & RollenLaden Sie Ihr Team ein und geben Sie jeder Person mit fünf klaren Rollen die richtige Zugriffsebene.
- EinstellungenSchlüssel, Ursprünge, eigene Modellschlüssel, Identitätsföderation, Limits, Abrechnung und Rabatte.
Widget
- Das WidgetBetten Sie das Syncanix-Chat-Widget mit einem einzigen Script-Tag in Ihre App ein — isoliert, verzögert und markengerecht.
- Widget-KonfigurationKonfigurieren Sie das Widget mit data-*-Attributen am Script-Tag.
- Laufzeit-API des WidgetsSteuern Sie das Widget aus JavaScript über das window.syncanix-Objekt.
- Das Widget gestaltenDas Widget passt sich Ihrer Marke automatisch an, mit voller Kontrolle, wenn Sie sie wollen.
- Größen & ModiDas Widget gibt es in fünf Größen und zwei Layout-Modi — wählen Sie, was an jeden Einsatzort passt.
- Das Chat-ErlebnisWas Ihre Nutzer in einer Unterhaltung sehen — gestreamte Antworten, Vorschläge, Aktionskarten, Hinweise und mehr.
- Das Headless-SDKBauen Sie eine vollständig eigene Chat-Oberfläche auf Syncanix, ohne das Widget einzubinden.
- Barrierefreiheit & RTLDas Widget erfüllt WCAG 2.1 AA und wird in Rechts-nach-links-Sprachen korrekt dargestellt.
MCP-Server
- Der MCP-ServerJeder Arbeitsbereich erhält einen eigenen MCP-Server, damit KI-Clients wie Claude Desktop, Cursor und ChatGPT Ihre Fähigkeiten erreichen.
- Einen Client verbindenVerbinden Sie Claude Desktop, Cursor, ChatGPT und andere MCP-Clients mit Ihrem Arbeitsbereich.
- Wie die MCP-Anmeldung funktioniertMCP-Clients authentifizieren sich mit OAuth 2.1, föderiert an Ihren Identitätsanbieter — Syncanix hält nie die Anmeldedaten Ihrer Nutzer.
- Werkzeuge & AusführungWas der MCP-Server bereitstellt, wie riskante Werkzeuge gekennzeichnet sind und wie Aufrufe tatsächlich laufen.
- MCP-Limits & EndpunkteSitzungslimits und die OAuth- und Transport-Endpunkte, die der MCP-Server bereitstellt.
Authentifizierung und Zugriff
- Authentifizierung und ZugriffWie sich Menschen bei Syncanix anmelden — Ihr Team am Dashboard, Ihre eigenen Nutzer am Chat — samt der Schlüssel, Identitätsanbieter und Schutzmechanismen, die beides verbinden.
- Anmeldung und ArbeitsbereicheWie Sie und Ihr Team sich am Syncanix-Dashboard anmelden und wie Arbeitsbereiche die Arbeit jedes Kontos sauber getrennt halten.
- Ihre Nutzer authentifizierenDie vier Möglichkeiten, wie das Widget Ihre eigenen Endnutzer authentifizieren kann, und wie Sie die passende für Ihren Stack wählen.
- Einen Identitätsanbieter verbindenVerbinden Sie Auth0, Clerk, Amazon Cognito oder WorkOS im Dashboard, damit Syncanix Ihre Endnutzer über den von Ihnen bereits genutzten Anbieter authentifizieren kann.
- API-SchlüsselErstellen, anzeigen und widerrufen Sie die beiden Schlüsselarten, die Syncanix ausstellt — einen geheimen Schlüssel für CLI und MCP und einen veröffentlichbaren Schlüssel für das eingebettete Widget.
- Step-up und AktionssicherheitWie Syncanix jede Aktion als Lesen, Schreiben oder destruktiv einstuft — und die Bestätigungs-, Neuverifizierungs- und Rückgängig-Kontrollen, die jede davon schützen.
Abrechnung & Tarife
- Abrechnung & TarifeWie Syncanix abrechnet: Tarife pro Arbeitsbereich, Abrechnung nach Endnutzern, Abonnements, die Nutzung eines eigenen Modellschlüssels und die Limits, die den Verbrauch planbar halten.
- TarifeDie fünf Syncanix-Tarife — Dev, Starter, Growth, Scale und Enterprise — sowie Testphasen, jährliche Abrechnung und Rabatte für gemeinnützige Organisationen, Bildung und Open Source.
- Nutzung & MessungWie Syncanix die Nutzung mit monatlich aktiven Endnutzern (MAEU) misst, wie die Zählung funktioniert, was an Ihrem Limit geschieht und wo Sie es verfolgen.
- Ihr Abonnement verwaltenStarten, ändern oder kündigen Sie einen Syncanix-Tarif, verwalten Sie Ihre Zahlungsmethode über das Paddle-Abrechnungsportal und finden Sie Ihre Rechnungen und Belege.
- Eigener Schlüssel (BYOK)Nutzen Sie Ihren eigenen Anthropic- oder OpenAI-Schlüssel, damit die Modellnutzung direkt von Ihrem Anbieter ohne Syncanix-Aufschlag abgerechnet wird. Schlüssel sind nur schreibbar und im Ruhezustand verschlüsselt.
- Ratenlimits & AusgabengrenzenDie Leitplanken, die die Syncanix-Nutzung planbar halten: Ratenlimits der Plattform, die die Stabilität schützen, und Ausgabengrenzen, die Sie selbst konfigurieren, um im Budget zu bleiben.
Vertrauen, Datenschutz & Compliance
- Vertrauen, Datenschutz & ComplianceWie Syncanix Ihre Daten und die Ihrer Endnutzer schützt: EU-Datenresidenz, Mandantenisolation, was wir verarbeiten und aufbewahren, Ihre Datenschutzrechte, unser Compliance-Programm und KI-Transparenz.
- Datenresidenz & SicherheitSyncanix läuft vollständig in AWS eu-central-1 (Frankfurt), isoliert die Daten jedes Kunden auf vier Ebenen und verschlüsselt Daten während der Übertragung und im Ruhezustand.
- Datenverarbeitung & AufbewahrungWelche Daten Syncanix verarbeitet, wie Zero Data Retention (ZDR) mit Modellanbietern funktioniert, was die Discovery-CLI sendet und wie lange Daten aufbewahrt werden.
- Datenschutz & Ihre RechteWie das Assistenten-Gedächtnis gesteuert wird, wie personenbezogene Daten gehandhabt werden und wie Sie und Ihre Endnutzer DSGVO- und CCPA-Rechte über das Datenanfrageformular ausüben können.
- Compliance & UnterauftragsverarbeiterDas Compliance-Programm von Syncanix: DSGVO- und CCPA-Unterstützung mit verfügbarem AVV, SOC 2 und ISO 27001 in Arbeit, und die Unterauftragsverarbeiter, auf die wir uns stützen.
- KI-TransparenzWie Syncanix Endnutzern in jeder Sprache den KI-Einsatz offenlegt, welche Modelle den Assistenten antreiben und wie Antworten auf Ihren Inhalten beruhen.
Anleitungen
- AnleitungenAufgabenorientierte Durchläufe, die die Referenzdokumentation zu vollständigen Aufgaben verbinden — das Widget starten, einen KI-Client verbinden, Antworten gründen, für einen Nutzer handeln und live gehen.
- Das Chat-Widget zu Ihrer Website hinzufügenVom Code zum Live-Chat-Widget: Entdecken Sie Ihre API mit der CLI, prüfen Sie den Katalog, gestalten Sie das Widget und betten Sie das Snippet ein.
- Einen KI-Client mit Ihrem Arbeitsbereich verbindenVerbinden Sie Claude Desktop, Cursor oder ChatGPT mit Ihrem Syncanix-MCP-Server, damit ein KI-Client Ihre API in Ihrem Namen nutzen kann.
- Antworten auf Ihren Inhalten gründenFügen Sie Ihre Dokumentation und Inhalte hinzu, damit der Assistent aus Ihrem Material antwortet, statt zu raten, und prüfen Sie, dass es funktioniert.
- Den Assistenten für einen angemeldeten Nutzer handeln lassenErlauben Sie dem Assistenten, authentifizierte Aktionen im Namen eines angemeldeten Endnutzers auszuführen, begrenzt auf dessen Berechtigungen, mit Bestätigung vor sensiblen Aktionen.
- Halten Sie Ihren Katalog aktuellFühren Sie die Erkennung bei API-Änderungen erneut aus, verdrahten Sie sie in CI, und lassen Sie die Laufzeit-Drift-Erkennung fangen, was durchrutscht.
- Datenexport und LöschungWie Betroffenenanfragen mit Syncanix funktionieren — Zugriffs-, Export- und Löschanfragen stellen, die Antwortfristen, und wer was übernimmt.
- In Produktion gehenBringen Sie Ihren Assistenten von Test zu Live: zur Produktionsumgebung wechseln, Live-Schlüssel erstellen, erlaubte Ursprünge festlegen, einen Tarif wählen und Leitplanken aktivieren.
- FehlerbehebungSymptomorientierte Lösungen für die Probleme, die wir wirklich sehen: ein blockiertes Widget, eine langsame erste Anfrage, Erkennungsfehler, Anreicherungsfehler und Anmeldeprobleme.
Referenz
- ReferenzEine konsolidierte Nachschlagestelle: Schnellfakten, Schlüssel- und ID-Formate, Plattformlimits und -standardwerte sowie Verweise auf die CLI-Referenz, die MCP-Referenz, die Framework-Unterstützung und das Glossar.
- Schlüssel, Token & IDsEine konsolidierte Nachschlagestelle der in Syncanix verwendeten Anmeldedaten- und Kennungsformate: geheime und veröffentlichbare API-Schlüssel, MCP-Verbindungstoken und Umgebungen.
- Limits & StandardwerteEine einzige Nachschlagestelle für übergreifende Plattformfakten: Datenregion, Protokollaufbewahrung, Ratenlimit-Antworten, die Messeinheit, Ausgabengrenzen und die unterstützten Sprachen.
- Laufzeit-API-ReferenzDie kundenseitigen Laufzeitverträge: der signierte Intent-Header, den Ihr Backend prüft, der Act-as-User-Vertrag, den es beobachtet, und die Form der Witness-Daten.