> ## Documentation Index
> Fetch the complete documentation index at: https://docs.famulor.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Famulor SDK

> Ein typisierter TypeScript-Client für Famulor-Integrationen in Ihrer Serveranwendung

<Frame>
  <img src="https://mintcdn.com/ouraicall/Hpff3gs2PfOUdmrH/images/changelog/famulor-sdk-2026-10-10.png?fit=max&auto=format&n=Hpff3gs2PfOUdmrH&q=85&s=bd15c1f8f2e02d792b2ed4190b46fd4f" alt="Famulor SDK mit Famulor-Maskottchen, Logo und TypeScript-Code" width="1672" height="941" data-path="images/changelog/famulor-sdk-2026-10-10.png" />
</Frame>

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.

```bash theme={null}
npm install famulor-sdk
```

```typescript theme={null}
import { Famulor } from 'famulor-sdk';

const client = new Famulor({
  apiKey: process.env.FAMULOR_API_KEY,
});

const { data: assistants } = await client.assistants.list({ limit: 10 });
console.log(assistants.map(({ id, name }) => ({ id, name })));
```

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

<Warning>
  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.
</Warning>

Für ein Sprachgespräch auf Ihrer Website verwenden Sie das [Web-Widget](/de/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

| Werkzeug | Geeignet für |
| - | - |
| SDK | TypeScript- und JavaScript-Code in Ihrem Backend |
| [REST-API](/de/api-reference/introduction) | HTTP-Integrationen in beliebigen Sprachen |
| [CLI](/de/cli/overview) | Terminalbefehle, Skripte und CI-Jobs |
| [MCP](/de/mcp/overview) | Zugriff eines KI-Assistenten auf Workspace-Werkzeuge |

Die SDK-Methode `client.assistants.list()` ist beispielsweise auch in der CLI verfügbar:

```bash theme={null}
npm install --global famulor
famulor auth login
famulor list-assistants --limit 10 --output table
```

API-Zugriff steuert SDK- und REST-Anfragen. **KI verbinden / MCP** steuert den MCP-Zugriff separat.

## Erste Schritte

<CardGroup cols={2}>
  <Card title="Schnellstart" href="/de/sdk/quickstart" icon="bolt">
    Installation, API-Schlüssel und erste Leseanfrage mit anschließendem ausgehendem Anruf.
  </Card>

  <Card title="SDK verwenden" href="/de/sdk/usage" icon="code">
    Antworten, Paginierung, vollständiger API-Zugriff und Dateianfragen.
  </Card>

  <Card title="Konfiguration und Fehler" href="/de/sdk/reference" icon="sliders">
    Authentifizierung, eigene Domains, Wiederholungen, Timeouts und Fehlerbehebung.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.