Skip to main content
Famulor SDK mit Famulor-Maskottchen, Logo und TypeScript-Code
Integrieren Sie Famulor mit dem offiziellen TypeScript-SDK in Ihr Backend. Listen Sie Assistenten auf, starten Sie Anrufe, lesen Sie Gesprächsergebnisse und verwalten Sie Workspace-Ressourcen mit typisierten Anfragen und Antworten.

Was das SDK bietet

  • Vollständiger Zugriff auf die öffentliche API. Jede dokumentierte API-Operation ist über client.api verfügbar.
  • Praktische Ressourcenmethoden. Nutzen Sie client.assistants.list(), client.calls.create() und client.calls.get() für häufige Aufgaben.
  • Typen aus dem API-Vertrag. Ihr Editor zeigt Anfragefelder, erlaubte Werte und Antwortfelder an.
  • Vorhersehbare Anfragen. Konfigurieren Sie Timeouts, brechen Sie Anfragen mit einem AbortSignal ab und behandeln Sie strukturierte Fehler.
  • Paginierung. Verarbeiten Sie den Anrufverlauf mit einem asynchronen Iterator, der Seiten bei Bedarf lädt.
  • Sichere Wiederholungen. Geeignete Leseanfragen können wiederholt werden. Schreibanfragen werden nie automatisch wiederholt.

Voraussetzungen

Verwenden Sie Node.js 22 oder neuer und einen Workspace mit API-Zugriff über Ihren Tarif oder ein Add-on. Das SDK verwendet dieselben Zugangsdaten, Berechtigungen, Rollen und Workspace-Limits wie die REST-API.
Dies ist ein Server-SDK. Bewahren Sie API-Schlüssel und OAuth-Tokens in Ihrem Backend oder einem Secret-Store auf. Importieren Sie das SDK niemals in Browser-Code und geben Sie Zugangsdaten nicht über öffentliche Umgebungsvariablen frei.
Für ein Sprachgespräch auf Ihrer Website verwenden Sie das Web-Widget. Das Server-SDK verwaltet Ressourcen und Anrufe; es nimmt kein Mikrofonaudio auf und stellt keine Gesprächsoberfläche dar.

SDK, CLI und MCP

Die SDK-Methode client.assistants.list() ist beispielsweise auch in der CLI verfügbar:
API-Zugriff steuert SDK- und REST-Anfragen. KI verbinden / MCP steuert den MCP-Zugriff separat.

Erste Schritte

Schnellstart

Installation, API-Schlüssel und erste Leseanfrage mit anschließendem ausgehendem Anruf.

SDK verwenden

Antworten, Paginierung, vollständiger API-Zugriff und Dateianfragen.

Konfiguration und Fehler

Authentifizierung, eigene Domains, Wiederholungen, Timeouts und Fehlerbehebung.