zum Hauptinhalt springen
Dokumentation durchsuchen

Schnellstart

Von Ihrer bestehenden API zu einem funktionierenden Assistenten in Ihrer App – in etwa 90 Minuten.

Diese Anleitung führt Sie von einer bestehenden App zu einem laufenden Syncanix-Assistenten: Ihre API erkennen, prüfen, was der Assistent kann, Ihr Backend anbinden, das Widget einbetten und in die Produktion überführen. Die meisten Teams schaffen das in rund 90 Minuten.

Bevor Sie beginnen

  • Ein Syncanix-Arbeitsbereich — registrieren Sie sich unter app.syncanix.com.
  • Node.js 20 oder neuer.
  • Eine bestehende HTTP-API mit mindestens einem authentifizierten Endpunkt.
  • Ein Identitätsanbieter für Ihre Nutzer – Auth0, Clerk, Cognito, WorkOS oder Ihr eigener OIDC.
  • Ein Anthropic-, OpenAI- oder AWS-Bedrock-EU-Schlüssel — oder nutzen Sie den verwalteten Modellzugang, der in Ihrem Plan enthalten ist.

Arbeitsbereich und Schlüssel einrichten

Die Discovery-CLI lädt in einen Syncanix-Arbeitsbereich hoch, und das Widget authentifiziert sich mit einem veröffentlichbaren Schlüssel — legen Sie also den Arbeitsbereich an und holen Sie sich beide Schlüssel, bevor Sie irgendetwas ausführen.

  1. Ihren Arbeitsbereich erstellenRegistrieren Sie sich unter app.syncanix.com. Im Dashboard liegen Ihr Katalog, Ihre API-Schlüssel und Ihre Widget-Konfiguration.
  2. Ihren CLI-Schlüssel hinterlegenFühren Sie npx syncanix login aus und fügen Sie den geheimen Schlüssel (gak_…) ein, der unter Einstellungen → API-Schlüssel angezeigt wird. Die CLI speichert ihn in ~/.syncanix/credentials, damit init Ihren Katalog hochladen kann.
  3. Ihren veröffentlichbaren Schlüssel kopierenKopieren Sie unter Einstellungen → API-Schlüssel im Dashboard Ihren veröffentlichbaren Schlüssel (pk_live_…). Das Widget-Einbettungs-Snippet verwendet ihn als data-key — er kann gefahrlos im Browser ausgeliefert werden.
npx syncanix login

1. Erkennen Sie Ihre API

Führen Sie die CLI in Ihrem Projekt aus. Sie erkennt Ihr Framework, liest Ihre Routen, schreibt einen Fähigkeitskatalog und lädt ihn hoch. Die Erkennung ist standardmäßig statisch: Sie liest Ihren Code, führt ihn nicht aus, und keine Produktionsdaten verlassen Ihren Rechner.

npx syncanix init

Die optionale KI-Anreicherung (klarere Titel und Beschreibungen) läuft erst, nachdem Sie an der Eingabeaufforderung ausdrücklich der Zero-Data-Retention zugestimmt haben. Sie können sie auch überspringen und später anreichern.

2. Prüfen Sie den Katalog

Öffnen Sie das Dashboard, um zu sehen, was erkannt wurde. Hier entscheiden Sie, was der Assistent tun darf – und wie vorsichtig:

  • Markieren Sie interne Endpunkte, damit sie außerhalb der Reichweite des Assistenten bleiben.
  • Legen Sie die Nebenwirkung jeder Aktion fest – lesend, schreibend oder destruktiv –, was steuert, wie sie bestätigt wird.
  • Verlangen Sie für sensible Aktionen eine erhöhte Authentifizierung, damit der Nutzer seine Identität erneut bestätigt, bevor sie ausgeführt werden.

3. Backend anbinden (optional)

Wenn Sie es hinzufügen, installieren Sie das SDK in dem Dienst, dem Ihre API gehört. Es startet in wenigen Millisekunden und hält Ihren Katalog per Laufzeit-Drift-Erkennung aktuell:

npm install @syncanix/sdk-node
import { init } from '@syncanix/sdk-node';

// Resolves your API key from SYNCANIX_API_KEY, ~/.syncanix/credentials,
// or an inline { apiKey } — in that order.
const { environment, bootDurationMs } = await init({ environment: 'development' });
console.log(`Syncanix booted in ${bootDurationMs.toFixed(1)}ms`);

Sie können auch SDK-eigene Werkzeuge registrieren – Aktionen, die der Assistent aufrufen kann und die keine einfachen HTTP-Routen sind. Jede läuft mit der Identität des Endnutzers, die Ihr Identitätsanbieter liefert:

import { createToolRegistry } from '@syncanix/sdk-node';

const registry = createToolRegistry();

registry.tool({
  name: 'refund-order',
  description: 'Refund a customer order. Requires an admin role.',
  handler: async ({ orderId, amountCents }, ctx) => {
    // ctx.userId is the verified end user from your identity provider.
    return payments.refund({ orderId, amountCents, actor: ctx.userId });
  },
});

4. Betten Sie das Widget ein

Fügen Sie Ihrer App ein Script-Tag mit Ihrem veröffentlichbaren Schlüssel hinzu:

<script
  type="module"
  src="https://cdn.syncanix.com/widget.js"
  data-key="pk_live_..."
></script>

Das war’s. Das Widget lädt verzögert, läuft in einem Shadow DOM, damit Ihre und unsere Styles nie kollidieren, übernimmt Ihre Marke automatisch und ist bereit für Rechts-nach-links.

5. Verbinden Sie einen MCP-Client (optional)

Jeder Workspace erhält außerdem seinen eigenen MCP-Server, sodass Ihre Nutzer dieselben Fähigkeiten aus Claude Desktop, Cursor und ChatGPT erreichen. Die Anmeldung wird an Ihren Identitätsanbieter föderiert.

6. Überführen Sie in die Produktion

Wenn Sie mit dem Verhalten des Assistenten in der Entwicklung zufrieden sind, überführen Sie ihn im Dashboard in die Produktion. Zuvor läuft eine Bewertungsstufe, die die Überführung blockiert, wenn die Qualität nachlässt – so verändert sich die Produktion nur zum Besseren.

Was Sie jetzt haben

  • Einen eingebetteten Assistenten in Ihrer App, der Fragen beantwortet und Ihre Aktionen ausführt.
  • Ein MCP-Server pro Workspace für Claude Desktop, Cursor und ChatGPT.
  • Ein Prüfprotokoll jeder Aktion, jeder Überführung und jeder Administrationsänderung.
  • Alles in der EU gehostet, mit Ihren Daten verschlüsselt im Ruhezustand.

Nächste Schritte