Famulor SDKVoor TypeScript- en JavaScript-backends

Famulor in je code.
Getypeerd, veld voor veld.

Name: Famulor
Brand: Famulor
Price: 0.11 EUR
Availability: InStock

Toon assistenten, start gesprekken en lees resultaten met een paar regels TypeScript. Elke API-operatie is een methode, met autocomplete voor elk veld.

API-key aanmaken Lees de docs

$ npm install famulor-sdk

Types uit de OpenAPI
ESM en CommonJS
Geen dependencies

server.ts

$ npm install famulor-sdk
added 1 package in 1s

// server.ts
import { Famulor } from 'famulor-sdk'

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

const { data: call } = await client.calls.create({
  assistant_id: '3e8b1f6a-9c2d-4a7e-b1f5-6d7c8e9a0b55',
  to_number: '+4930123456',
})

console.log(call.id, call.status)

$ node server.ts
c7d21e4a-5b3f-4e8a-a1c9-2f6e0b7d9a13 queued

Methodes

Korte methodes voor elke dag. client.api voor de rest.

Zeven groepen dekken de meest voorkomende taken. Elke openbare API-operatie is daarnaast een getypeerde methode.

client.calls

Methodeslist()create()get()recording()iterate()

const { data: call } = await client.calls.create({

assistant_id: assistant.id,

to_number: '+4930123456',

})

const { data: result } = await client.calls.get(call.id)

console.log(result.status, result.summary)

Paginering

Je hele gespreksgeschiedenis. Eén loop.

De iterator haalt de volgende pagina pas op als je hem nodig hebt. Een break stopt het ophalen.

sync-calls.ts

for await (const call of client.calls.iterate({

status: 'completed',

limit: 50,

})) {

await saveToCrm(call)

if (isDone(call)) break

}

Verzoeken

Verwerkt

Pagina 1
niet opgehaald
Pagina 2
niet opgehaald
Pagina 3
niet opgehaald
Pagina 4
niet opgehaald
Pagina 5
niet opgehaald

Veilige retries

Lezen wordt herhaald. Gesprekken nooit dubbel.

Bij 429, 502, 503 of 504 probeert de SDK leesverzoeken opnieuw. Schrijfverzoeken zoals een gesprek starten worden nooit automatisch herhaald.

Lezen

GET /calls
503
Retry-Afteropnieuw
200 OK

Schrijven

POST /calls
timeout
~~retry~~geen tweede poging
mayHaveExecutedControleer de status voordat je opnieuw verstuurt.

Getypeerde fouten

FamulorApiError
Antwoord van de API met status, code en requestId.
FamulorTimeoutError
Termijn verlopen. mayHaveExecuted zegt of het uitgevoerd kan zijn.
FamulorNetworkError
Geen antwoord ontvangen, ook met mayHaveExecuted.
FamulorAbortError
Je AbortSignal heeft het verzoek geannuleerd.

Gebouwd voor productie

Voorspelbaar in elke omgeving.

Expliciete credentials, één vaste termijn per verzoek en geen globale state.

Jij geeft de key door

De SDK laadt geen .env-bestanden en kiest geen workspace voor je. Elke client kent alleen zijn eigen key.

Eén client per workspace

Een API-key hoort bij één workspace. Voor meerdere workspaces maak je meerdere clients.

Ook op je eigen domein

White-label-partners zetten baseUrl op hun eigen HTTPS-domein met /api/v1.

OAuth voor gebruikersapps

In plaats van een key geef je een OAuth-token of een functie die het actuele token geeft.

Eén termijn per verzoek

timeoutMs geldt voor token, retries en antwoord samen. Met een AbortSignal annuleer je altijd.

Bestanden en audio

Uploads gaan erin als FormData. Opnames en stemvoorbeelden komen terug als ArrayBuffer.

client.ts

const client = new Famulor({

apiKey: process.env.FAMULOR_API_KEY,

baseUrl: 'https://app.famulor.io/api/v1',

timeoutMs: 90_000,

maxRetries: 2,

})

const controller = new AbortController()

await client.calls.list(

{ status: 'completed', limit: 10 },

{ signal: controller.signal, timeoutMs: 10_000 },

)

SDK, CLI, MCP of API

Vier wegen naar Famulor. Kies wat past.

Alle vier werken met dezelfde workspace en dezelfde data.

Eén operatie, overal gelijk

SDKclient.calls.create()

RESTPOST /api/v1/calls

CLIfamulor create-call

Deze pagina

Famulor SDK

Voor TypeScript en JavaScript in je backend.

Elke API-operatie als methode
Types uit de OpenAPI
ESM en CommonJS

Lees de docs

Famulor CLI

Voor terminal, scripts, CI en coding agents.

Eén commando per operatie
JSON, tabel of JSONL
Key in de OS-sleutelhanger

Naar Famulor CLI

MCP Connector

Voor Claude, ChatGPT en andere AI-tools in de chat.

Eén server-URL, inloggen via OAuth
Famulor-tools direct in de chat
Niets lokaal te installeren

Naar MCP Connector

REST API

Voor HTTP-integraties in elke taal.

OpenAPI-specificatie
Realtime webhooks
Elke taal, elk framework

Naar API-referentie

Alles voor ontwikkelaars

In één oogopslag

Klein pakket. Volledige API.

API-dekking

100%

Elke openbare operatie via client.api.

Dependencies

Gebruikt de fetch van je Node.js-runtime.

Moduleformaten

ESM en CommonJS, met types voor beide.

Resourcegroepen

Assistenten, gesprekken, campagnes en meer.

Aan de slag

Je eerste gesprek in drie stappen.

Installeren, key aanmaken, aan de slag.

01
Installeren
npm install famulor-sdk. Draait op Node.js 22 of nieuwer, als ESM of CommonJS.
02
Key aanmaken
Maak een key aan in Settings → API & MCP en bewaar hem in de omgeving of secret manager van je server.
03
Aan de slag
new Famulor({ apiKey }) en dan client.assistants.list(). Je editor toont elk veld.

Werkt samen met

Meer uit het platform

Andere onderdelen die teams meestal combineren met deze functie.

Vragen vóór go-live

Wat is de Famulor SDK?

De Famulor SDK is de officiële TypeScript- en JavaScript-client voor de openbare Famulor API. Hij biedt korte methodes voor assistenten, gesprekken, campagnes, contacten, stemmen, kennisbanken en je account. Via client.api bereik je elke andere operatie, met types uit de OpenAPI-specificatie.

Wat heb ik nodig om de SDK te gebruiken?

Node.js 22 of nieuwer en een workspace met API Access via je abonnement of een add-on. Installeren doe je met npm install famulor-sdk. De API-key maak je in het dashboard onder Settings → API & MCP.

Kan ik de SDK in de browser of een app gebruiken?

De SDK draait op je server, zodat je API-key geheim blijft. Voor gesprekken direct op je website gebruik je de webwidget.

Kan een gesprek dubbel starten als de verbinding wegvalt?

Niet door de SDK. Schrijfverzoeken herhaalt hij nooit automatisch, ook niet na een rate limit. Na een timeout laat mayHaveExecuted zien of het verzoek al aangekomen kan zijn. Controleer de status voordat je opnieuw verstuurt.

Werkt het ook met gewoon JavaScript?

Ja. Het pakket levert ESM en CommonJS, dus je gebruikt import of require('famulor-sdk'). TypeScript-projecten krijgen de types automatisch.

Werkt het met meerdere workspaces en white-label?

Ja. Een API-key hoort bij precies één workspace, dus je maakt per workspace een eigen client. Op je eigen domein zet je baseUrl, bijvoorbeeld op https://app.example.com/api/v1.

Ondersteunt de SDK OAuth?

Ja. In plaats van apiKey geef je accessToken: een token of een functie die het actuele token geeft. Toestemming en token-vernieuwing regelt je app.

Wanneer gebruik ik de SDK, de CLI of de MCP Connector?

De SDK past in je backend. De CLI is voor terminal, scripts, CI en coding agents. De MCP Connector brengt Famulor naar chattools zoals Claude of ChatGPT. Alle drie gebruiken dezelfde API en workspace.

Aan de slag

Je eerste gesprek, een paar regels verderop.

Maak een API-key aan, installeer famulor-sdk en begin met client.assistants.list().

API-key aanmaken Lees de docs

De Famulor SDK is gratis en MIT-gelicentieerd. Je hebt Node.js 22 of nieuwer nodig en een abonnement met API Access.

Famulor SDKVoor TypeScript- en JavaScript-backends

Famulor in je code.
Getypeerd, veld voor veld.

Toon assistenten, start gesprekken en lees resultaten met een paar regels TypeScript. Elke API-operatie is een methode, met autocomplete voor elk veld.

API-key aanmaken Lees de docs

$ npm install famulor-sdk

Types uit de OpenAPI
ESM en CommonJS
Geen dependencies

server.ts

$ npm install famulor-sdk
added 1 package in 1s

// server.ts
import { Famulor } from 'famulor-sdk'

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

const { data: call } = await client.calls.create({
  assistant_id: '3e8b1f6a-9c2d-4a7e-b1f5-6d7c8e9a0b55',
  to_number: '+4930123456',
})

console.log(call.id, call.status)

$ node server.ts
c7d21e4a-5b3f-4e8a-a1c9-2f6e0b7d9a13 queued

Methodes

Korte methodes voor elke dag. client.api voor de rest.

Zeven groepen dekken de meest voorkomende taken. Elke openbare API-operatie is daarnaast een getypeerde methode.

client.calls

Methodeslist()create()get()recording()iterate()

const { data: call } = await client.calls.create({

assistant_id: assistant.id,

to_number: '+4930123456',

})

const { data: result } = await client.calls.get(call.id)

console.log(result.status, result.summary)

Paginering

Je hele gespreksgeschiedenis. Eén loop.

De iterator haalt de volgende pagina pas op als je hem nodig hebt. Een break stopt het ophalen.

sync-calls.ts

for await (const call of client.calls.iterate({

status: 'completed',

limit: 50,

})) {

await saveToCrm(call)

if (isDone(call)) break

}

Verzoeken

Verwerkt

Pagina 1
niet opgehaald
Pagina 2
niet opgehaald
Pagina 3
niet opgehaald
Pagina 4
niet opgehaald
Pagina 5
niet opgehaald

Veilige retries

Lezen wordt herhaald. Gesprekken nooit dubbel.

Bij 429, 502, 503 of 504 probeert de SDK leesverzoeken opnieuw. Schrijfverzoeken zoals een gesprek starten worden nooit automatisch herhaald.

Lezen

GET /calls
503
Retry-Afteropnieuw
200 OK

Schrijven

POST /calls
timeout
~~retry~~geen tweede poging
mayHaveExecutedControleer de status voordat je opnieuw verstuurt.

Getypeerde fouten

FamulorApiError
Antwoord van de API met status, code en requestId.
FamulorTimeoutError
Termijn verlopen. mayHaveExecuted zegt of het uitgevoerd kan zijn.
FamulorNetworkError
Geen antwoord ontvangen, ook met mayHaveExecuted.
FamulorAbortError
Je AbortSignal heeft het verzoek geannuleerd.

Gebouwd voor productie