> ## 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 de Famulor

> Un cliente TypeScript tipado para integrar Famulor en tu aplicación de servidor

<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 con la mascota, el logotipo y código TypeScript" width="1672" height="941" data-path="images/changelog/famulor-sdk-2026-10-10.png" />
</Frame>

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.

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

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

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

Para una conversación de voz en tu sitio web, usa el [Widget web](/es/web-widget). 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](/es/api-reference/introduction) | Integraciones HTTP en cualquier lenguaje |
| [CLI](/es/cli/overview) | Comandos de terminal, scripts y tareas CI |
| [MCP](/es/mcp/overview) | 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:

```bash theme={null}
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

<CardGroup cols={2}>
  <Card title="Inicio rápido" href="/es/sdk/quickstart" icon="bolt">
    Instalación, creación de una clave, primera lectura y llamada saliente.
  </Card>

  <Card title="Usar el SDK" href="/es/sdk/usage" icon="code">
    Respuestas, paginación, acceso completo a la API y archivos.
  </Card>

  <Card title="Configuración y errores" href="/es/sdk/reference" icon="sliders">
    Autenticación, dominios propios, reintentos, tiempos de espera y solución de problemas.
  </Card>
</CardGroup>


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