Skip to main content
One of Speckle’s most popular features is the ability to view gorgeous 3D models directly in your web browser. The Speckle viewer is the component that makes this possible, rendering large 3D models in your browser at rapid speeds. Speckle has made the Speckle viewer available as an Open Source project and freely available component which you can use within your own code or website. This section of the documentation explains what the Speckle viewer is and how to build upon it. We provide full documentation, explaining the concepts behind its design, introducing some simple and more advanced examples, and providing comprehensive documentation of its Application Programming Interface (API).
Building directly on this package, rather than just embedding it? Speckle’s data model is changing in 2026.9. If your application imports the Viewer package itself — extending render pipelines, forking extensions, reading render views/batches, or otherwise reaching into its internals — you’re exposed as soon as any data you load has been converted to the new format, and there’s no updated Viewer package for it yet. See Who’s affected and Viewer developer notes in 2026.9 before you hit this in production.
We use embedded live code sandboxes across the documentation to exemplify and provide live code that you can better understand. Depending on the browser you use and/or any extensions you might have installed, these embeds might fail to work correctly
🆕 You can now access the viewer sandbox from here: https://viewer.speckle.systems/
Last modified on September 7, 2026