Skip to main content
This page provides a complete reference for all classes, methods, components, hooks, types, and events in the Reactor SDK.

​
SDK Structure

The Reactor SDK is organized into several key components:

Reactor Class

The core class for connecting to and interacting with Reactor machines

React Components

ReactorProvider and ReactorView for React applications

React Hooks

useReactor and useReactorMessage hooks for state management

Types

TypeScript type definitions for status, state, errors, and more

Events

Event system for status changes, messages, and errors

​
Installation

Install the Reactor SDK via npm or pnpm:
  • npm
  • pnpm
npm install @reactor-team/js-sdk

​
Quick Start

import { Reactor } from "@reactor-team/js-sdk";

const reactor = new Reactor({
  insecureApiKey: process.env.REACTOR_API_KEY,
  modelName: "matrix-2"
});

await reactor.connect();
⌘I