Installation

The Java SDK connects JVM applications to Reactor models. These pages describe inc.reactor:reactor-sdk:1.0.0. Use the published Javadoc for the complete API.

Requirements

Use JDK 22 or later. Java 21 and earlier and Android are not supported by this SDK.

Platform	Requirements
Linux	x86_64 or aarch64, glibc 2.34+
macOS	Apple Silicon on macOS 11+, or Intel on macOS 13+
Windows	x86_64

Add the dependency

<dependency>
  <groupId>inc.reactor</groupId>
  <artifactId>reactor-sdk</artifactId>
  <version>1.0.0</version>
</dependency>

repositories {
    mavenCentral()
}

dependencies {
    implementation("inc.reactor:reactor-sdk:1.0.0")
}

The dependency includes the native libraries for all supported platforms. No separate download or compiler toolchain is needed.

Enable native access

Add the appropriate option to the JVM that runs your application:

java --enable-native-access=ALL-UNNAMED -cp "your-classpath" YourMainClass

java --enable-native-access=inc.reactor.sdk --module-path "your-module-path" --module your.app/your.MainClass

A modular application also declares requires inc.reactor.sdk; in its module-info.java. For Gradle’s application plugin, set applicationDefaultJvmArgs = listOf("--enable-native-access=ALL-UNNAMED") inside the application block for a classpath application.

Connect

Have your backend issue a short-lived, scoped JWT and provide it to your application. This example reads it from REACTOR_JWT; see Authentication for token issuance.

import inc.reactor.sdk.JsonValue;
import inc.reactor.sdk.Reactor;
import inc.reactor.sdk.ReactorOptions;

public class Connect {
    public static void main(String[] args) {
        String jwt = System.getenv("REACTOR_JWT");
        if (jwt == null || jwt.isBlank()) {
            throw new IllegalStateException("Set REACTOR_JWT to a scoped session token");
        }
        var options = ReactorOptions.builder("https://api.reactor.inc", "reactor/helios")
                .jwt(jwt)
                .build();
        try (Reactor reactor = Reactor.open(options)) {
            try {
                reactor.connect().join();
                reactor.sendCommand("set_prompt", JsonValue.object()
                        .put("prompt", "a mountain landscape")
                        .build()).join();
            } finally {
                reactor.disconnect().join();
            }
        }
    }
}

join() blocks the calling thread. Use future composition in a UI application, and keep blocking calls off the UI thread. disconnect() ends a session the client created; try-with-resources releases the client even if an operation fails.

Never bundle a Reactor API key in a desktop application. Keep it on your backend and give the application a scoped JWT.

Optional modules

Add these separately when needed, using the same 1.0.0 version:

Artifact in the `inc.reactor` group	Purpose
`reactor-sdk-audio`	Microphone and speaker helpers
`reactor-sdk-jackson`	Adapters between `JsonValue` and Jackson’s `JsonNode`
`reactor-sdk-kotlin`	Kotlin suspend functions and flows

The base SDK does not open a microphone or speaker automatically.

Reactor

Connect, send commands, upload files, and download recordings.

Track

Receive and send video and audio frames.

Types

JSON values, replies, events, and errors.

Get Started

Concepts

SDK Reference

Resources

Requirements

Add the dependency

Enable native access

Connect

Optional modules

Reactor

Track

Types

​Requirements

​Add the dependency

​Enable native access

​Connect

​Optional modules

Reactor

Track

Types

Requirements

Add the dependency

Enable native access

Connect

Optional modules