Skip to main content
Famulor SDK with the Famulor mascot, logo and TypeScript code
Build Famulor into your backend with the official TypeScript SDK. List assistants, start calls, read conversation results and manage workspace resources with typed requests and responses.

What you get

  • Complete public API coverage. Every documented API operation is available through client.api.
  • Convenient resource methods. Use client.assistants.list(), client.calls.create() and client.calls.get() for common tasks.
  • Types from the API contract. Your editor shows request fields, allowed values and response properties.
  • Predictable requests. Configure timeouts, cancel with an AbortSignal and handle structured errors.
  • Pagination. Process call history with an async iterator that fetches pages as you need them.
  • Safe retry defaults. Eligible read requests may be repeated. Write requests are never retried automatically.

Requirements

Use Node.js 22 or newer and a workspace with API Access, enabled by your plan or an add-on. The SDK uses the same API credentials, scopes, roles and workspace limits as the REST API.
This is a server SDK. Keep API keys and OAuth tokens in your backend or secret store. Never import the SDK into browser code or expose a credential in a public environment variable.
For a voice conversation inside your website, use the Web widget. The server SDK manages resources and calls; it does not capture microphone audio or render a conversation interface.

SDK, CLI and MCP

For example, the SDK’s client.assistants.list() is also available in the CLI:
API Access controls SDK and REST requests. Connect AI / MCP controls MCP access separately.

Start building

Quickstart

Install, create a key and run your first read and outbound call.

Use the SDK

Responses, pagination, complete API coverage and file requests.

Configuration and errors

Authentication, custom domains, retries, timeouts and troubleshooting.