SDK de Famulor - Famulor

Famulor SDK con la mascota, el logotipo y código TypeScript

Integra Famulor en tu backend con el SDK oficial de TypeScript. Lista asistentes, inicia llamadas, consulta los resultados de las conversaciones y gestiona recursos del espacio de trabajo con solicitudes y respuestas tipadas.

npm install famulor-sdk

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

Qué ofrece el SDK

Toda la API pública. Cada operación documentada está disponible mediante client.api.
Métodos de recursos prácticos. Usa client.assistants.list(), client.calls.create() y client.calls.get() para tareas habituales.
Tipos del contrato de la API. Tu editor muestra campos, valores permitidos y propiedades de respuesta.
Solicitudes predecibles. Configura tiempos de espera, cancela con un AbortSignal y gestiona errores estructurados.
Paginación. Recorre el historial de llamadas con un iterador asíncrono que carga páginas cuando las necesitas.
Reintentos seguros. Las lecturas compatibles pueden repetirse. Las escrituras nunca se repiten automáticamente.

Requisitos

Usa Node.js 22 o posterior y un espacio de trabajo con Acceso a la API mediante tu plan o un complemento. El SDK usa las mismas credenciales, permisos, roles y límites que la API REST.

Este es un SDK de servidor. Guarda las claves API y los tokens OAuth en tu backend o gestor de secretos. Nunca importes el SDK en código del navegador ni expongas credenciales en variables de entorno públicas.

Para una conversación de voz en tu sitio web, usa el Widget web. El SDK de servidor gestiona recursos y llamadas; no captura el micrófono ni muestra una interfaz de conversación.

SDK, CLI y MCP

Herramienta	Uso recomendado
SDK	Código TypeScript y JavaScript en tu backend
API REST	Integraciones HTTP en cualquier lenguaje
CLI	Comandos de terminal, scripts y tareas CI
MCP	Acceso de un asistente de IA a las herramientas del espacio de trabajo

Por ejemplo, client.assistants.list() también está disponible en la CLI:

npm install --global famulor
famulor auth login
famulor list-assistants --limit 10 --output table

Acceso a la API controla las solicitudes del SDK y REST. Conectar IA / MCP controla el acceso a MCP por separado.

Empieza a desarrollar

Inicio rápido

Instalación, creación de una clave, primera lectura y llamada saliente.

Usar el SDK

Respuestas, paginación, acceso completo a la API y archivos.

Configuración y errores

Autenticación, dominios propios, reintentos, tiempos de espera y solución de problemas.

​Qué ofrece el SDK

​Requisitos

​SDK, CLI y MCP

​Empieza a desarrollar

Inicio rápido

Usar el SDK

Configuración y errores

Qué ofrece el SDK

Requisitos

SDK, CLI y MCP

Empieza a desarrollar