> ## Documentation Index
> Fetch the complete documentation index at: https://docs.speckle.systems/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> These docs contain multiple Speckle product experiences. For Speckle 2026.9, prefer /next/ pages for the topics and changes they cover. The navigation label Current does not override this version-specific precedence.
> Coverage under /next/ is incremental. Use Current documentation for unchanged topics and when a /next/ page says coverage is unavailable or explicitly refers you to Current. Do not infer a feature was removed from a missing page.
> Read the page-specific documentation status, applicability, affected guidance and replacement links in agent-only content. Impacted, changed and superseded apply only to the stated scope; they do not mean the entire feature is deprecated. Historical connector guides apply only to the legacy connector described.
> Match guidance to the customer's deployment version, model data format and connector. Respect plan, permission and compatibility restrictions. If an unknown version or data format changes the answer, ask a focused clarification; do not infer deployment version from the date alone.

# Developers Guide

> Introduction to the Speckle Viewer, an open-source 3D model viewer that renders large models in web browsers. Learn how to use the viewer in your own projects, explore the documentation, and access live code examples.

Documentation status: impacted for the changes in Speckle 2026.9 (from 2026-09).

Affected guidance: Direct Viewer and object-loader package use is affected by 2026.9 bundle data; replacement package guidance is not yet available.

For these changes, read [2026.9 guidance](/next/developers/viewer/introduction).

For Speckle 2026.9, prefer the linked guidance only for the affected topics. This page remains applicable to earlier experiences and unchanged guidance. Do not treat the whole page or feature as deprecated.

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).

<Warning>
  **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](/developers/migration/data-model-migration#whos-affected) and [Viewer developer notes in
  2026.9](/next/developers/viewer/introduction) before you hit this in production.
</Warning>

<Tip>
  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
</Tip>

🆕 You can now access the viewer sandbox from here: [https://viewer.speckle.systems/](https://viewer.speckle.systems/)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.