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

# SDK Famulor

> Un client TypeScript typé pour intégrer Famulor à votre application serveur

<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 avec la mascotte, le logo et du code TypeScript" width="1672" height="941" data-path="images/changelog/famulor-sdk-2026-10-10.png" />
</Frame>

Intégrez Famulor à votre backend avec le SDK TypeScript officiel. Listez les assistants, lancez des appels, consultez les résultats des conversations et gérez les ressources de votre espace de travail avec des requêtes et des réponses typées.

```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 })));
```

## Ce que propose le SDK

* **Toute l’API publique.** Chaque opération documentée est disponible via `client.api`.
* **Des méthodes pratiques.** Utilisez `client.assistants.list()`, `client.calls.create()` et `client.calls.get()` pour les tâches courantes.
* **Des types issus du contrat API.** Votre éditeur affiche les champs, les valeurs autorisées et les propriétés des réponses.
* **Des requêtes prévisibles.** Configurez les délais, annulez avec un `AbortSignal` et traitez les erreurs structurées.
* **La pagination.** Parcourez l’historique des appels avec un itérateur asynchrone qui charge les pages à la demande.
* **Des répétitions sûres.** Les lectures éligibles peuvent être répétées. Les écritures ne sont jamais répétées automatiquement.

## Prérequis

Utilisez **Node.js 22 ou une version ultérieure** et un espace de travail avec **Accès API**, inclus dans votre forfait ou un module complémentaire. Le SDK utilise les mêmes identifiants, autorisations, rôles et limites que l’API REST.

<Warning>
  Il s’agit d’un SDK serveur. Conservez les clés API et les jetons OAuth dans votre backend ou votre gestionnaire de secrets. N’importez jamais le SDK dans du code navigateur et n’exposez aucun identifiant dans une variable d’environnement publique.
</Warning>

Pour une conversation vocale sur votre site, utilisez le [Widget web](/fr/web-widget). Le SDK serveur gère les ressources et les appels ; il ne capture pas le microphone et n’affiche pas d’interface de conversation.

## SDK, CLI et MCP

| Outil | Usage recommandé |
| - | - |
| SDK | Code TypeScript et JavaScript dans votre backend |
| [API REST](/fr/api-reference/introduction) | Intégrations HTTP dans n’importe quel langage |
| [CLI](/fr/cli/overview) | Commandes de terminal, scripts et tâches CI |
| [MCP](/fr/mcp/overview) | Accès d’un assistant IA aux outils de votre espace de travail |

Par exemple, `client.assistants.list()` est également disponible dans la CLI :

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

Accès API contrôle les requêtes SDK et REST. **Connecter l’IA / MCP** contrôle séparément l’accès MCP.

## Commencer

<CardGroup cols={2}>
  <Card title="Démarrage rapide" href="/fr/sdk/quickstart" icon="bolt">
    Installation, création d’une clé, première lecture et appel sortant.
  </Card>

  <Card title="Utiliser le SDK" href="/fr/sdk/usage" icon="code">
    Réponses, pagination, accès complet à l’API et fichiers.
  </Card>

  <Card title="Configuration et erreurs" href="/fr/sdk/reference" icon="sliders">
    Authentification, domaines personnalisés, répétitions, délais et dépannage.
  </Card>
</CardGroup>


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