Skip to main content

Install the reference client

New to Reactor? How the API works explains the session, camera streams, commands, and action messages used below. You need Python 3.12, uv, a Reactor API key, and Reactor’s public cookbook. The client code is public; your Reactor account still needs access to the selected hosted model. No local model weights or GPU are required for this example.
Run the example below from robotics/sim/notebooks/. This environment installs the Python SDK and helpers from the Robotics Cookbook for camera publishing and message queues. The cookbook helpers are separate from the SDK. Keep your API key in the environment. On Linux, the published glibc wheel requires glibc 2.34 or newer. The default endpoint is https://api.reactor.inc; REACTOR_API_URL overrides it. Examples select a model by slug, not a frozen release; check its release notes when the deployed contract changes. If setup or connection fails, open your model guide and follow its troubleshooting page.

Request a chunk

Run the cookbook example from the current robotics/sim/notebooks/ directory:
Expect a checkpoint name and actions: (32, 8): 32 steps, each with seven joint targets and one gripper value. The example checks connectivity and reply shape using test inputs; do not execute these outputs on hardware. The helper keeps publishing the test images so that each camera supplies a frame after the request. For robot control, replace them with fresh camera images. To compare checkpoints, start a separate session for each choice and select it from available before sending state. Next, build a simulator adapter or use the integration guide with your robot client.