Skip to main content
Documentation

Five SDK

Render captured spaces, control the camera, handle spatial interactions, and export images with the published Five SDK.

On this page

Build a spatial viewer with Five SDK. Start with one working React + TypeScript project, then add the capability your app needs.

Use Five SDK 6.9.2, Three.js 0.117.1, React 18.3.1, and Node 24 for the starter and extension examples.

Start with a result

Run the public scene without an account or keys. The same starter also supports server-side Team data.

Open the starter's SDK examples page to explore camera movement, modes, picking, labels, and image capture. Each guide below points to the actual source file included in that project.

Choose a capability

GoalGuidePublic API used
Load Work and release resourcesLoad a sceneparseWork, appendTo, load, refresh, dispose
Change view, viewpoint, or cameraCamera and modeschangeMode, moveToPano, updateCamera, getCurrentState
React to taps and place a labelEvents and coordinateson, model.intersectRaycaster, project2d
Export the current frameCapture an imagegetSize, getPixels
Mount inside a React appReact lifecyclecomponent mount, cancellation, resize, cleanup
Connect a deployed appProduction checklistassets, server authorization, browser resources
Find a method or eventAPI mapfixed-version types and package AI guides

Dnalogel adds spatial UI and measurement. Vreo adds narrative playback. Live adds room-based synchronization. These products have their own dependency and service requirements.

Versioned sources

Use the versioned API declarations for method signatures, event payloads, and type definitions.