Introduction to the Speckle Viewer, an open-source 3D model viewer that renders large models in web browsers. Learn how to load Speckle bundles into it, use it in your own projects, and access live code examples.
These pages document Viewer 2 (@speckle/viewer 2.x), which was built for the object-data format
used before 2026.9. Viewer 3 is not released. The bridge described here lets an existing Viewer 2
application consume current bundle-backed models, but it rebuilds the old object shape in memory
and does not provide Viewer 3’s large-model capabilities. Without that bridge, the published
Viewer 2 package has no bundle loader and a bundle version renders nothing. See Loading Speckle
data for the available paths.
Speckle lets you view 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).
Loading Speckle data
A version’s data is a bundle of parquet files, not an
object graph fetched from the objects endpoints. The published Viewer package converts object
graphs, so it needs a bridge to render a bundle.The rest of the package is unaffected. Render pipelines, extensions, filtering, selection, queries,
the world tree and view modes all work the same way, because the change is in where the data comes
from, not in what the viewer does with it once converted.
Am I affected?
How your app uses the Viewer
Affected
Imports @speckle/viewer, constructs a Viewer and a loader
Yes
Extends render pipelines or extensions, reads render views or batches
No
Embeds the hosted web viewer in an iframe
No
Reads data only through the GraphQL or REST API
No
Load bundles
Load bundles yourself
Add about a dozen files to your app, keep the same published packages, and render bundles. Sample
code and a step-by-step path.
The bridge is sample code rather than a package release, so you own the copy and it carries a date.
The guide says what it does and does not cover.The bridge keeps your app on the object graph the bundle format replaced, by rebuilding that graph
in memory. The format is built for streaming reads, sharded geometry, and querying properties
without materialising objects. Getting the performance the format allows needs a viewer built for
it. Plan for that, and treat the bridge as a way to keep working until it arrives.
Not the Viewer package
Two nearby cases have their own pages.
A data-only JavaScript app that reads Speckle data without rendering it, built on
@speckle/objectloader or @speckle/objectloader2, should read the bundle directly rather than
bridging to an object graph. Start from Building custom apps.
The 3D viewer in the web app is not this package. See 3D viewer.
Package reference
The API reference in this section documents the published package. The surface the bridge relies
on, Loader, SpeckleLoader, WorldTree, and loadObject, is documented in
Loaders, the Loader API, and the
World tree API.
The documentation embeds live code sandboxes. Depending on your browser and extensions, these
embeds might not work.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Speckle Docs","colors":{"primary":"#155DFC","light":"#51A2FF","dark":"#2B7FFF"},"logo":{"light":"https://mintcdn.com/speckle/8FGkkbZZbcuHzOBq/logo/light.svg?fit=max\u0026auto=format\u0026n=8FGkkbZZbcuHzOBq\u0026q=85\u0026s=9fc87cac252fa8cc443a9828ecbace70","dark":"https://mintcdn.com/speckle/8FGkkbZZbcuHzOBq/logo/dark.svg?fit=max\u0026auto=format\u0026n=8FGkkbZZbcuHzOBq\u0026q=85\u0026s=560ffcf355d3abfde56e5f8e514a64b7"},"favicon":"https://mintcdn.com/speckle/H0UAly7sy_Ci378-/favicon-docs.svg?fit=max\u0026auto=format\u0026n=H0UAly7sy_Ci378-\u0026q=85\u0026s=024a646efe6d1f271e2e537e4e58a606","background":{"color":{"light":"#FAFAFA","dark":"#09090B"}},"navbar":{"links":[{"href":"https://speckle.systems/","label":"Website"},{"href":"https://speckle.community/","label":"Community"}],"primary":{"type":"button","label":"Open Speckle","href":"https://app.speckle.systems/?utm_source=Docs\u0026utm_medium=SignUp\u0026utm_campaign=Docs"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/specklesystems","youtube":"https://www.youtube.com/@SpeckleSystems","github":"https://github.com/specklesystems","instagram":"https://www.instagram.com/specklesystems"}},"icons":{"library":"fontawesome"},"integrations":{"ga4":{"measurementId":"G-05WEYFZ28C"},"intercom":{"appId":"hoiaq4wn"},"mixpanel":{"projectToken":"acd87c5a50b56df91a795e999812a3a4"}},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"metadata":{"timestamp":true},"markdown":{"instructions":["These docs describe Speckle as it works today, including everything released in 2026.9. Treat page content as current unless the page or section says it applies only to versions published before 2026.9.","Content scoped to versions published before 2026.9 (the object graph and root object, Proxies, Receive2, operations.receive, object.children) applies only to model versions in that earlier data format. For versions published in 2026.9, answer from the Object model pages and the SDK migration guides.","The What's new pages summarise what changed in 2026.9 and link to the page that documents each change. Answer from the linked page rather than from the summary. Legacy (v2) connectors are retired; send questions about them to the community help forum.","Match guidance to the customer's deployment, model data format, connector, plan and permissions. Self-hosted servers on a release before 2026.9 follow Data model migration for developers. If an unknown version or data format changes the answer, ask one focused question; do not infer the deployment version from the date alone."]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"speckle","hasAudioNarration":false,"actualSubdomain":"speckle","customDomains":["docs.speckle.systems"],"gitSource":{"type":"github","owner":"specklesystems","repo":"speckle-docs-new","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"issues":true},"entitlements":{},"buildId":"6aff239e97e1b315b98c095b","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Developers","count":213},{"language":"default","tag":"User Guides","count":95},{"language":"default","tag":"SDKs","count":65},{"language":"default","tag":"API Reference","count":54},{"language":"default","tag":"Viewer","count":50},{"language":"default","tag":"Connectors","count":39},{"language":"default","tag":"Publishing \u0026 Loading","count":37},{"language":"default","tag":"C# .NET","count":33},{"language":"default","tag":"Python","count":30},{"language":"default","tag":"Interfaces","count":29}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#footer div:first-child>div:first-child>div:first-child{display:none}.header-link+p{margin-top:0.6rem}li .frame{margin-top:1rem;margin-bottom:1.5rem}div:has(>.frame)+div:has(>.frame){margin-top:0.75rem}:root{--sp-surface-0: #fafafa;--sp-surface-1: #fcfcfc;--sp-border: #e4e4e7;--sp-bg-elevated: #f4f4f5;--sp-text-highlighted: #18181b;--sp-text-muted: #71717b;--sp-header-height: 56px}:root.dark{--sp-surface-0: #09090b;--sp-surface-1: #111113;--sp-border: #27272a;--sp-bg-elevated: #27272a;--sp-text-highlighted: #ffffff;--sp-text-muted: #9f9fa9}#sidebar [class*=\"bg-linear-to-b\"]{background-image:linear-gradient(to bottom, var(--sp-surface-1), transparent)!important}#sidebar [class*=\"bg-neutral-50\"][class*=\"rounded-full\"]{background:transparent!important}#sidebar li[data-active]>a{background:var(--sp-bg-elevated)!important;color:var(--sp-text-highlighted)!important}@media (min-width: 1024px){:root{--mintlify-slot-header-height: calc(var(--sp-header-height) + var(--topbar-tabs-height, 0rem))}div:has(>#sidebar){max-width:none!important;margin-left:0!important;margin-right:0!important;padding-left:0!important}#sidebar{background:var(--sp-surface-1);border-right:1px solid var(--sp-border)}#sidebar>div{left:16px!important;right:8px!important}div:has(>[data-layout-item=\"content\"]){max-width:1184px;margin-left:auto;margin-right:auto;padding-inline:48px}#navbar [class*=\"max-w-8xl\"]{max-width:none!important}body:has(#sidebar) #navbar #navbar-transition{border-bottom:1px solid var(--sp-border)!important;background:linear-gradient(\n to right,\n var(--sp-surface-1) 0,\n var(--sp-surface-1) calc(var(--sidebar-width, 18rem) - 1px),\n var(--sp-border) calc(var(--sidebar-width, 18rem) - 1px),\n var(--sp-border) var(--sidebar-width, 18rem),\n var(--sp-surface-0) var(--sidebar-width, 18rem)\n )!important}#navbar div:has(>div>div>a>img.nav-logo){height:var(--sp-header-height)!important;padding-left:32px!important}#navbar div:has(>div>div>a>img.nav-logo)>div{border-bottom:0!important}#navbar img.nav-logo{height:28px!important}#navbar div:has(>div>div>a>img.nav-logo)>div>div:first-child{flex:1 1 auto!important}#navbar div:has(>div>div>a>img.nav-logo)>div>div:nth-child(2){flex:0 0 auto!important;margin-left:auto;width:32px}#navbar div:has(>div>div>a>img.nav-logo)>div>div:nth-child(3){flex:0 0 auto!important;margin-left:16px}#navbar div:has(>div>div>a>img.nav-logo)>div>div:nth-child(3) a:has(>[class*=\"bg-primary\"]){height:32px!important;padding-top:0!important;padding-bottom:0!important}#search-bar-entry{width:32px!important;height:32px!important;padding:0!important;justify-content:center!important;border:0!important;border-radius:6px!important;background:transparent!important;box-shadow:none!important}#search-bar-entry:hover{background:var(--sp-bg-elevated)!important}#search-bar-entry [data-search-item=\"trigger-icon\"]{width:16px!important;height:16px!important;color:var(--sp-text-muted)!important}#search-bar-entry:hover [data-search-item=\"trigger-icon\"]{color:var(--sp-text-highlighted)!important}#search-bar-entry [data-search-item=\"trigger-label\"],#search-bar-entry [data-search-item=\"trigger-hint\"]{display:none!important}body:has(#sidebar) #navbar div:has(>.nav-tabs){padding-left:calc(var(--sidebar-width, 18rem) + 32px)!important}}@media (min-width: 1440px){:root,body,body *{--topbar-tabs-height: 0rem !important}body:has(.nav-tabs) #navbar div:has(>div>.nav-tabs){display:grid!important}body:has(.nav-tabs) #navbar div:has(>div>.nav-tabs)>*{grid-area:1 / 1}#navbar div:has(>.nav-tabs){height:var(--sp-header-height)!important;pointer-events:none;align-items:stretch}#navbar .nav-tabs{pointer-events:auto}#content-side-layout{top:calc(var(--sp-header-height) + 48px)!important}}"}]}
{"page":{"pagePath":"developers/viewer/introduction","slug":"/developers/viewer/introduction","pageMetadata":{"title":"Developers Guide","sidebarTitle":"Getting Started","description":"Introduction to the Speckle Viewer, an open-source 3D model viewer that renders large models in web browsers. Learn how to load Speckle bundles into it, use it in your own projects, and access live code examples.","href":"/developers/viewer/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Introduction to the Speckle Viewer, an open-source 3D model viewer that renders large models in web browsers. Learn how to load Speckle bundles into it, use it in your own projects, and access live code examples.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Card,Heading,Table,Tip,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[`These pages document Viewer 2 (`,_jsx(_components.code,{children:`@speckle/viewer`}),` 2.x), which was built for the object-data format\nused before 2026.9. Viewer 3 is not released. The bridge described here lets an existing Viewer 2\napplication consume current bundle-backed models, but it rebuilds the old object shape in memory\nand does not provide Viewer 3’s large-model capabilities. Without that bridge, the published\nViewer 2 package has no bundle loader and a bundle version renders nothing. See `,_jsx(_components.a,{href:`#loading-speckle-data`,children:`Loading Speckle\ndata`}),` for the available paths.`]})}),`\n`,_jsx(_components.p,{children:`Speckle lets you view 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.`}),`\n`,_jsx(_components.p,{children:`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.`}),`\n`,_jsx(_components.p,{children:`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).`}),`\n`,_jsx(Heading,{level:`2`,id:`loading-speckle-data`,children:`Loading Speckle data`}),`\n`,_jsxs(_components.p,{children:[`A version’s data is a `,_jsx(_components.a,{href:`/developers/building-integrations/bundles`,children:`bundle`}),` of parquet files, not an\nobject graph fetched from the objects endpoints. The published Viewer package converts object\ngraphs, so it needs a bridge to render a bundle.`]}),`\n`,_jsx(_components.p,{children:`The rest of the package is unaffected. Render pipelines, extensions, filtering, selection, queries,\nthe world tree and view modes all work the same way, because the change is in where the data comes\nfrom, not in what the viewer does with it once converted.`}),`\n`,_jsx(Heading,{level:`3`,id:`am-i-affected`,children:`Am I affected?`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`How your app uses the Viewer`}),_jsx(_components.th,{children:`Affected`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Imports `,_jsx(_components.code,{children:`@speckle/viewer`}),`, constructs a `,_jsx(_components.code,{children:`Viewer`}),` and a loader`]}),_jsx(_components.td,{children:`Yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Extends render pipelines or extensions, reads render views or batches`}),_jsx(_components.td,{children:`No`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Embeds the hosted web viewer in an iframe`}),_jsx(_components.td,{children:`No`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Reads data only through the GraphQL or REST API`}),_jsx(_components.td,{children:`No`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`load-bundles`,children:`Load bundles`}),`\n`,_jsx(Card,{title:`Load bundles yourself`,icon:`download`,href:`/developers/viewer/loading-bundles`,children:_jsx(_components.p,{children:`Add about a dozen files to your app, keep the same published packages, and render bundles. Sample\ncode and a step-by-step path.`})}),`\n`,_jsx(_components.p,{children:`The bridge is sample code rather than a package release, so you own the copy and it carries a date.\nThe guide says what it does and does not cover.`}),`\n`,_jsx(_components.p,{children:`The bridge keeps your app on the object graph the bundle format replaced, by rebuilding that graph\nin memory. The format is built for streaming reads, sharded geometry, and querying properties\nwithout materialising objects. Getting the performance the format allows needs a viewer built for\nit. Plan for that, and treat the bridge as a way to keep working until it arrives.`}),`\n`,_jsx(Heading,{level:`3`,id:`not-the-viewer-package`,children:`Not the Viewer package`}),`\n`,_jsx(_components.p,{children:`Two nearby cases have their own pages.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`A data-only JavaScript app`}),` that reads Speckle data without rendering it, built on\n`,_jsx(_components.code,{children:`@speckle/objectloader`}),` or `,_jsx(_components.code,{children:`@speckle/objectloader2`}),`, should read the bundle directly rather than\nbridging to an object graph. Start from `,_jsx(_components.a,{href:`/developers/building-apps`,children:`Building custom apps`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`The 3D viewer in the web app`}),` is not this package. See `,_jsx(_components.a,{href:`/3d-viewer/introduction`,children:`3D viewer`}),`.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`package-reference`,children:`Package reference`}),`\n`,_jsxs(_components.p,{children:[`The API reference in this section documents the published package. The surface the bridge relies\non, `,_jsx(_components.code,{children:`Loader`}),`, `,_jsx(_components.code,{children:`SpeckleLoader`}),`, `,_jsx(_components.code,{children:`WorldTree`}),`, and `,_jsx(_components.code,{children:`loadObject`}),`, is documented in\n`,_jsx(_components.a,{href:`/developers/viewer/loaders`,children:`Loaders`}),`, the `,_jsx(_components.a,{href:`/developers/viewer/loader-api`,children:`Loader API`}),`, and the\n`,_jsx(_components.a,{href:`/developers/viewer/world-tree-api`,children:`World tree API`}),`.`]}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`The documentation embeds live code sandboxes. Depending on your browser and extensions, these\nembeds might not work.`})}),`\n`,_jsxs(_components.p,{children:[`Try the viewer in the sandbox at `,_jsx(_components.a,{href:`https://viewer.speckle.systems/`,children:`viewer.speckle.systems`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Developers Guide","sidebarTitle":"Getting Started","description":"Introduction to the Speckle Viewer, an open-source 3D model viewer that renders large models in web browsers. Learn how to load Speckle bundles into it, use it in your own projects, and access live code examples.","href":"/developers/viewer/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Loading Speckle data","slug":"loading-speckle-data","depth":2,"children":[{"title":"Am I affected?","slug":"am-i-affected","depth":3,"children":[]},{"title":"Load bundles","slug":"load-bundles","depth":3,"children":[]},{"title":"Not the Viewer package","slug":"not-the-viewer-package","depth":3,"children":[]}]},{"title":"Package reference","slug":"package-reference","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/speckle/338e4d421a1293df/.omp/extensions/atlas-sync.js"],"subdomain":"speckle","siteName":"Speckle Docs","title":"Developers Guide - Speckle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T09:31:09.526Z","gitLastModified":"2026-11-12T09:30:51.000Z","originalFileLocation":"developers/viewer/introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Introduction to the Speckle Viewer, an open-source 3D model viewer that renders large models in web browsers. Learn how to load Speckle bundles into it, use it in your own projects, and access live code examples.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Speckle Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Developers Guide - Speckle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Introduction to the Speckle Viewer, an open-source 3D model viewer that renders large models in web browsers. Learn how to load Speckle bundles into it, use it in your own projects, and access live code examples.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Speckle Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.speckle.systems/developers/viewer/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://speckle.mintlify.site/_mintlify/api/og/v2?division=Speckle+Viewer\u0026amp;title=Developers+Guide\u0026amp;description=Introduction+to+the+Speckle+Viewer%2C+an+open-source+3D+model+viewer+that+renders+large+models+in+web+browsers.+Learn+how+to+load+Speckle+bundles+into+it%2C+use+it+\u0026amp;theme=3e6fae5609aa483790e4f77c\u0026amp;signature=f701e2f54e113944469064ecce62ab69b74aa95862eada2d4f17216a77ed4d8d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Developers Guide - Speckle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Introduction to the Speckle Viewer, an open-source 3D model viewer that renders large models in web browsers. Learn how to load Speckle bundles into it, use it in your own projects, and access live code examples.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://speckle.mintlify.site/_mintlify/api/og/v2?division=Speckle+Viewer\u0026amp;title=Developers+Guide\u0026amp;description=Introduction+to+the+Speckle+Viewer%2C+an+open-source+3D+model+viewer+that+renders+large+models+in+web+browsers.+Learn+how+to+load+Speckle+bundles+into+it%2C+use+it+\u0026amp;theme=3e6fae5609aa483790e4f77c\u0026amp;signature=f701e2f54e113944469064ecce62ab69b74aa95862eada2d4f17216a77ed4d8d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/speckle/f7DEGxLA7h3Bcgui/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Speckle Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#155DFC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.speckle.systems/developers/viewer/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/viewer/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.speckle.systems/#organization\",\"name\":\"Speckle Docs\",\"url\":\"https://docs.speckle.systems\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/speckle/8FGkkbZZbcuHzOBq/logo/light.svg?fit=max\u0026auto=format\u0026n=8FGkkbZZbcuHzOBq\u0026q=85\u0026s=9fc87cac252fa8cc443a9828ecbace70\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.speckle.systems#website\",\"name\":\"Speckle Docs\",\"url\":\"https://docs.speckle.systems\",\"publisher\":{\"@id\":\"https://docs.speckle.systems/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.speckle.systems/developers/viewer/introduction#webpage\",\"url\":\"https://docs.speckle.systems/developers/viewer/introduction\",\"name\":\"Developers Guide\",\"description\":\"Introduction to the Speckle Viewer, an open-source 3D model viewer that renders large models in web browsers. Learn how to load Speckle bundles into it, use it in your own projects, and access live code examples.\",\"dateModified\":\"2026-11-12T09:30:51.000Z\",\"isPartOf\":{\"@id\":\"https://docs.speckle.systems#website\"},\"breadcrumb\":{\"@id\":\"https://docs.speckle.systems/developers/viewer/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.speckle.systems/developers/viewer/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Speckle Docs\",\"item\":\"https://docs.speckle.systems\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Developers Guide\",\"item\":\"https://docs.speckle.systems/developers/viewer/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.speckle.systems/developers/viewer/introduction#article\",\"headline\":\"Developers Guide\",\"name\":\"Developers Guide\",\"description\":\"Introduction to the Speckle Viewer, an open-source 3D model viewer that renders large models in web browsers. Learn how to load Speckle bundles into it, use it in your own projects, and access live code examples.\",\"url\":\"https://docs.speckle.systems/developers/viewer/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.speckle.systems/developers/viewer/introduction#webpage\"},\"dateModified\":\"2026-11-12T09:30:51.000Z\",\"publisher\":{\"@id\":\"https://docs.speckle.systems/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.speckle.systems#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Speckle Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Speckle Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/developers/viewer/introduction.md","siteName":"Speckle Docs","nav":{"global":null,"dropdowns":[{"dropdown":"User Guides","icon":"book-open","groups":[{"group":"Quick Reference","pages":[{"title":"Welcome to Speckle","sidebarTitle":"Welcome","href":"/quickstart/welcome"},{"title":"Speckle's new data model: what has changed for you","sidebarTitle":"Data model migration","href":"/workspaces/data-model-migration"},{"title":"Quickstart Guide","href":"/quickstart/quickstart"},{"title":"Frequently Asked Questions","href":"/quickstart/faq"},{"title":"What's new in 2026.9 for workspace users","sidebarTitle":"What's new","href":"/whats-new/users"}]},{"group":"Your Speckle Workspace","pages":[{"title":"Organize teams and projects","sidebarTitle":"Overview","href":"/workspaces/introduction"},{"group":"Projects, Models, and Versions","pages":[{"title":"Projects","href":"/workspaces/projects"},{"title":"Models","href":"/workspaces/models"},{"title":"Version Control","href":"/workspaces/versions"}]},{"group":"Access and Identity","pages":[{"title":"Roles and permissions","href":"/workspaces/roles-and-seats"},{"title":"Invite to Workspace","href":"/workspaces/inviting"},{"title":"Workspace Discoverability","href":"/workspaces/workspace-discoverability"},{"title":"Domain Protection","href":"/workspaces/domain-protection"},{"title":"Single Sign-On (SSO)","tag":"Enterprise","href":"/workspaces/sso"},{"title":"User provisioning (SCIM)","sidebarTitle":"Provisioning (SCIM)","tag":"Enterprise","href":"/workspaces/scim"}]},{"group":"Plans and Governance","pages":[{"title":"Plans and Governance","sidebarTitle":"Overview","href":"/workspaces/plans-and-governance"},{"title":"Billing","href":"/workspaces/billing"},{"title":"Data Residency","tag":"Enterprise","href":"/workspaces/data-residency"}]},{"group":"Configuration","pages":[{"title":"Configuration","href":"/workspaces/configuration"},{"title":"Check workspace activity, plan limits, and AI spend","sidebarTitle":"Usage","href":"/workspaces/usage"},{"title":"Project metadata","tag":"Enterprise","href":"/workspaces/configuration/project-metadata"}]}]},{"group":"Viewing \u0026 Sharing","pages":[{"title":"Open and explore models in the 3D viewer","sidebarTitle":"Overview","href":"/3d-viewer/introduction"},{"title":"Interface and navigation","href":"/3d-viewer/interface-nav"},{"group":"Inspect and Compare","pages":[{"title":"Filter, browse, and measure your model","sidebarTitle":"Exploration","href":"/3d-viewer/exploration"},{"title":"Compare versions","href":"/3d-viewer/compare-versions"},{"title":"Combine models in one scene","sidebarTitle":"Model federation","href":"/3d-viewer/federation"}]},{"group":"Feedback and Tracking","pages":[{"title":"Issues","href":"/3d-viewer/issues"},{"title":"Sketch on your model","sidebarTitle":"Sketch","href":"/3d-viewer/markups"},{"title":"Saved views","href":"/3d-viewer/saved-views"}]},{"group":"Present and Share","pages":[{"title":"Present a model with saved views","sidebarTitle":"Presentation","href":"/3d-viewer/presentation"},{"title":"Share your models","href":"/3d-viewer/sharing"}]}]},{"group":"Publishing \u0026 Loading","pages":[{"title":"Connectors, cloud integrations, and file uploads","sidebarTitle":"Overview","href":"/connectors/overview"},{"group":"Connectors","pages":[{"title":"Installing Connectors","href":"/connectors/installation"},{"title":"Connector Assets \u0026 Templates","sidebarTitle":"Assets \u0026 Templates","href":"/connectors/assets"},{"group":"Revit","pages":[{"title":"How to use Speckle for Revit","sidebarTitle":"Quickstart","href":"/connectors/revit/revit"},{"title":"Loading blocks as families in Revit","sidebarTitle":"Blocks as Families","href":"/connectors/revit/blocks-to-families"}]},{"group":"Rhino","pages":[{"title":"How to use Speckle for Rhino","sidebarTitle":"Quickstart","href":"/connectors/rhino/rhino"},{"title":"Revit Categorization","href":"/connectors/rhino/rhino-revit"},{"title":"RhinoInside","sidebarTitle":"RhinoInside","href":"/connectors/grasshopper/grasshopper-integrations"}]},{"group":"Grasshopper","pages":[{"title":"How to use Speckle for Grasshopper","sidebarTitle":"Quickstart","href":"/connectors/grasshopper/grasshopper"},{"title":"Explore what an object is connected to","sidebarTitle":"Explore","href":"/connectors/grasshopper/explore"},{"title":"Models","href":"/connectors/grasshopper/grasshopper-models"},{"title":"Collections","href":"/connectors/grasshopper/grasshopper-collections"},{"title":"Objects","href":"/connectors/grasshopper/grasshopper-objects"},{"title":"Properties","href":"/connectors/grasshopper/grasshopper-properties"},{"title":"Developer Nodes","href":"/connectors/grasshopper/grasshopper-developer"},{"title":"Recommendations","href":"/connectors/grasshopper/grasshopper-recommendations"},{"title":"Karamba3D","sidebarTitle":"Karamba3D","tag":"Third-Party","href":"/connectors/third-party/karamba3d"},{"title":"ShapeDiver","sidebarTitle":"ShapeDiver","tag":"Third-Party","href":"/connectors/third-party/shapediver"}]},{"title":"How to use Speckle for SketchUp","sidebarTitle":"SketchUp","href":"/connectors/sketchup"},{"group":"Power BI","pages":[{"title":"How to use Speckle for Power BI","sidebarTitle":"Quickstart","href":"/connectors/power-bi/power-bi"},{"title":"Power BI Data Gateway","sidebarTitle":"Data Gateway","href":"/connectors/power-bi/gateway"}]},{"title":"How to use Speckle for Archicad","sidebarTitle":"Archicad","href":"/connectors/archicad"},{"title":"Publish Navisworks models to Speckle","sidebarTitle":"Navisworks","href":"/connectors/navisworks"},{"title":"How to use Speckle for Blender","sidebarTitle":"Blender","href":"/connectors/blender"},{"title":"How to use Speckle for Civil 3D","sidebarTitle":"Civil 3D","href":"/connectors/civil3d"},{"title":"How to use Speckle for Plant 3D","sidebarTitle":"Plant 3D","href":"/connectors/plant3d"},{"title":"How to use Speckle for AutoCAD","sidebarTitle":"AutoCAD","href":"/connectors/autocad"},{"title":"How to use Speckle for ETABS","sidebarTitle":"ETABS","href":"/connectors/etabs"},{"title":"How to use Speckle for Tekla Structures","sidebarTitle":"Tekla Structures","href":"/connectors/teklastructures"},{"title":"How to use Speckle for Vectorworks","sidebarTitle":"Vectorworks","tag":"Third-Party","href":"/connectors/third-party/vectorworks"}]},{"group":"Cloud Integrations","pages":[{"title":"Autodesk Forma Data Management","sidebarTitle":"Forma Data Management (ACC)","tag":"Enterprise","href":"/connectors/cloud-integrations/acc"},{"title":"Sync models from Trimble Connect","sidebarTitle":"Trimble Connect","tag":"Enterprise","href":"/connectors/cloud-integrations/trimble-connect"},{"title":"Sync models from SharePoint","sidebarTitle":"SharePoint","href":"/connectors/cloud-integrations/sharepoint"},{"title":"Bentley ProjectWise","sidebarTitle":"Bentley ProjectWise","tag":"Enterprise","href":"/connectors/cloud-integrations/projectwise"},{"title":"Databricks","sidebarTitle":"Databricks","href":"/connectors/cloud-integrations/databricks"},{"title":"Snowflake","sidebarTitle":"Snowflake","href":"/connectors/cloud-integrations/snowflake"}]},{"title":"Direct uploads","href":"/connectors/direct-uploads/introduction"}]},{"group":"Analytics \u0026 Intelligence","pages":[{"group":"Intelligence","pages":[{"title":"Ask questions about your models with Speckle Intelligence","sidebarTitle":"Speckle Intelligence","href":"/analytics/intelligence"},{"title":"Reuse organisation playbooks with Intelligence skills","sidebarTitle":"Skills","href":"/analytics/intelligence-skills"},{"title":"Set standing AI Rules for the workspace","sidebarTitle":"AI Rules","href":"/analytics/intelligence-rules"},{"title":"Create and share Intelligence Reports","sidebarTitle":"Reports","href":"/analytics/reports"}]},{"group":"Dashboards","pages":[{"title":"Intelligence Dashboards","sidebarTitle":"Overview","href":"/analytics/intelligence-dashboards"},{"title":"Retired and replaced dashboard widgets","sidebarTitle":"Widget availability","href":"/analytics/dashboards-widget-availability"},{"title":"Layout","sidebarTitle":"Layout","href":"/analytics/dashboards/layout"},{"title":"Sharing","sidebarTitle":"Sharing","href":"/analytics/dashboards/sharing"},{"title":"Filters","sidebarTitle":"Filters","href":"/analytics/dashboards/filters"},{"title":"Lookup tables","sidebarTitle":"Lookup tables","href":"/analytics/dashboards/lookup-tables"},{"title":"Calculated fields","sidebarTitle":"Calculated fields","href":"/analytics/dashboards/calculated-fields"},{"title":"Common workflows","sidebarTitle":"Common workflows","href":"/analytics/dashboards/common-workflows"}]},{"group":"Data Validation","pages":[{"title":"Data Validation","sidebarTitle":"Overview","href":"/analytics/data-validation/overview"},{"title":"Checks","sidebarTitle":"Checks","href":"/analytics/data-validation/checks"},{"title":"Project standards","sidebarTitle":"Standards","href":"/analytics/data-validation/standards"},{"title":"Viewing Results","sidebarTitle":"Viewing Results","href":"/analytics/data-validation/viewing-results"},{"title":"Validation Widgets in Dashboards","sidebarTitle":"Validation Widgets","href":"/analytics/dashboards/validation-widgets"}]},{"group":"Data Conditioning","pages":[{"title":"Update parameters from the model viewer","sidebarTitle":"Parameter Updater","href":"/beta/parameter-updater"}]}]},{"group":"Workflows","pages":[{"title":"Combine capabilities into outcomes","sidebarTitle":"Overview","href":"/workflows/overview"},{"title":"Assess model changes with Speckle Intelligence","sidebarTitle":"Compare versions with Intelligence","href":"/workflows/assess-model-changes"},{"title":"Take off quantities and cost with Speckle Intelligence","sidebarTitle":"Quantity \u0026 cost takeoff","href":"/workflows/take-off-quantities"},{"title":"Benchmark a project against your portfolio with Speckle Intelligence","sidebarTitle":"Portfolio benchmarking","href":"/workflows/benchmark-against-your-portfolio"},{"title":"Validate incoming models automatically","sidebarTitle":"Automatic model validation","href":"/workflows/validate-incoming-models-automatically"},{"title":"Design review workflow","sidebarTitle":"Design Review","href":"/workflows/design-review-workflow"},{"title":"Componentised Grasshopper workflow","sidebarTitle":"Grasshopper","href":"/workflows/grasshopper-componentised-workflow"},{"title":"Compare parametric design options from Grasshopper","sidebarTitle":"Design Explorer","href":"/workflows/grasshopper-design-explorer"},{"title":"Extract Revit room data with SpecklePy","sidebarTitle":"Revit room data extraction","href":"/workflows/revit-room-data-extraction-specklepy"},{"title":"Analyse model data with SpecklePy and DuckDB","sidebarTitle":"SpecklePy analytics","href":"/workflows/specklepy-model-data-analytics"}]}],"global":{"anchors":[]}},{"dropdown":"Developers","icon":"code","tabs":[{"tab":"Build with Speckle","pages":[{"title":"Build with Speckle","href":"/developers/introduction"}]},{"tab":"Data Schema","pages":[{"title":"Data Schema","href":"/developers/object-model/overview"}]},{"tab":"Interfaces","pages":[{"title":"Interfaces","href":"/developers/api/graphql"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/developers/sdks/introduction"}]},{"tab":"Viewer","groups":[{"group":"Speckle Viewer","pages":[{"title":"Developers Guide","sidebarTitle":"Getting Started","href":"/developers/viewer/introduction"},{"title":"Load a bundle in your Viewer app","sidebarTitle":"Loading bundles","description":"Sample code and a step-by-step path for rendering bundle versions with the published Viewer package, without waiting for a new package release.","href":"/developers/viewer/loading-bundles"},{"title":"Installation","href":"/developers/viewer/installation"},{"title":"Basic Setup","href":"/developers/viewer/basic-setup"},{"title":"Advanced Setup","href":"/developers/viewer/advanced-setup"}]},{"group":"Core Concepts","pages":[{"title":"3D Viewer","href":"/developers/viewer/overview"},{"title":"Data Tree","href":"/developers/viewer/viewer-data"},{"title":"Rendering","href":"/developers/viewer/viewer-rendering"},{"title":"Loaders","href":"/developers/viewer/loaders"}]},{"group":"API Reference","pages":[{"group":"Viewer Core","pages":[{"title":"AccelerationStructure","href":"/developers/viewer/acceleration-structure-api"},{"title":"Batch","href":"/developers/viewer/batch-api"},{"title":"BatchObject","href":"/developers/viewer/batch-object-api"},{"title":"GeometryConverter","href":"/developers/viewer/geometry-converter-api"},{"title":"Input","href":"/developers/viewer/input-api"},{"title":"Intersections","href":"/developers/viewer/intersections-api"},{"title":"Loader","href":"/developers/viewer/loader-api"},{"title":"Queries","href":"/developers/viewer/queries-api"},{"title":"NodeRenderView","href":"/developers/viewer/render-view-api"},{"title":"RenderTree","href":"/developers/viewer/render-tree-api"},{"group":"Rendering Pipelines","pages":[{"title":"Pipeline","href":"/developers/viewer/rendering-pipeline-api/pipeline-api"},{"title":"ProgressivePipeline","href":"/developers/viewer/rendering-pipeline-api/progressive-pipeline-api"},{"title":"GPass","href":"/developers/viewer/rendering-pipeline-api/g-pass-api"},{"title":"BaseGPass","href":"/developers/viewer/rendering-pipeline-api/base-g-pass-api"},{"title":"ProgressiveGPass","href":"/developers/viewer/rendering-pipeline-api/progressive-g-pass-api"}]},{"title":"SpeckleMaterial","href":"/developers/viewer/speckle-material-api"},{"title":"SpeckleRenderer","href":"/developers/viewer/speckle-renderer-api"},{"title":"TopLevelAccelerationStructure","href":"/developers/viewer/top-level-acceleration-structure-api"},{"title":"Viewer","href":"/developers/viewer/viewer-api"},{"title":"WorldTree","href":"/developers/viewer/world-tree-api"}]},{"group":"Extensions","pages":[{"title":"Extension","href":"/developers/viewer/extensions/extension-api"},{"title":"CameraController","href":"/developers/viewer/extensions/camera-controller-api"},{"title":"DifExtension","href":"/developers/viewer/extensions/diff-extension-api"},{"title":"FilteringExtension","href":"/developers/viewer/extensions/filtering-extension-api"},{"title":"MeasurementsTool","href":"/developers/viewer/extensions/measurements-tool-api"},{"title":"SelectionExtension","href":"/developers/viewer/extensions/selection-extension-api"},{"title":"SectionTool","href":"/developers/viewer/extensions/section-tool-api"},{"title":"SectionToolOutlines","href":"/developers/viewer/extensions/section-tool-outlines-api"},{"title":"SpeckleControls","href":"/developers/viewer/extensions/speckle-controls-api"},{"title":"SmoothOrbitControls","href":"/developers/viewer/extensions/smooth-orbit-controls-api"},{"title":"ViewModes","href":"/developers/viewer/extensions/view-modes-api"}]}]},{"group":"Examples","pages":[{"title":"Basic Example","href":"/developers/viewer/examples/basic-example"},{"title":"More Extensions","href":"/developers/viewer/examples/more-extensions-example"},{"title":"Filtering","href":"/developers/viewer/examples/filtering-example"},{"title":"Loading Data","href":"/developers/viewer/examples/loading-example"},{"title":"Object Manipulation","href":"/developers/viewer/examples/object-manipulation-example"},{"title":"Box Selection","href":"/developers/viewer/examples/box-selection-example"},{"title":"Animation \u0026 Custom Text","href":"/developers/viewer/examples/categorize-example"}]},{"group":"Reference","pages":[{"title":"Migration Guide","href":"/developers/viewer/migration-guide"},{"title":"Backwards Compatibility","href":"/developers/viewer/migration-guide-compatibility"},{"title":"API 1.0 Full Migration","href":"/developers/viewer/migration-guide-v1"}]}]},{"tab":"Server","pages":[{"title":"Server","href":"/developers/server/introduction"}]},{"tab":"Automate","pages":[{"title":"Automate","href":"/developers/automate/introduction"}]}],"global":{"anchors":[]}},{"dropdown":"IT Administrators","icon":"wrench","groups":[{"group":"Deployment \u0026 Maintenance","pages":[{"title":"IT setup guide","href":"/it-admin/setup"},{"title":"Keep connectors current across your estate","sidebarTitle":"Connector updates","href":"/it-admin/connector-updates"},{"title":"Security","href":"/it-admin/security"},{"group":"Cloud Integrations","pages":[{"title":"Cloud Integrations: Access and Governance","sidebarTitle":"Introduction","href":"/it-admin/integrations/introduction"},{"title":"Enable Autodesk Forma Data Management integration","sidebarTitle":"Forma Data Management (ACC)","tag":"Enterprise","href":"/it-admin/integrations/acc"},{"title":"Configure Bentley ProjectWise Integration","sidebarTitle":"Bentley ProjectWise","tag":"Enterprise","href":"/it-admin/integrations/projectwise"},{"title":"Approve Speckle for SharePoint","sidebarTitle":"SharePoint","href":"/it-admin/integrations/sharepoint"},{"title":"Enable Databricks Integration","sidebarTitle":"Databricks","href":"/it-admin/integrations/databricks"},{"title":"Enable Snowflake Integration","sidebarTitle":"Snowflake","href":"/it-admin/integrations/snowflake"}]},{"title":"Admin Support Mode","href":"/it-admin/support-mode"},{"title":"Archive and unarchive projects","sidebarTitle":"Project Archival","tag":"Enterprise","href":"/it-admin/archived-projects"},{"title":"What's new in 2026.9 for IT admins","sidebarTitle":"What's new","href":"/whats-new/it-admins"}]},{"group":"Manual Connector Installation","pages":[{"title":"Manual installation","sidebarTitle":"Overview","href":"/connectors/manual-installation/introduction"},{"title":"Desktop Services","sidebarTitle":"Desktop Services (deprecated)","href":"/connectors/manual-installation/desktop-services"},{"title":"Archicad","href":"/connectors/manual-installation/archicad"},{"title":"AutoCAD","href":"/connectors/manual-installation/autocad"},{"title":"Blender","href":"/connectors/manual-installation/blender"},{"title":"Civil 3D","href":"/connectors/manual-installation/civil3d"},{"title":"ETABS","href":"/connectors/manual-installation/etabs"},{"title":"Navisworks","href":"/connectors/manual-installation/navisworks"},{"title":"Power BI","href":"/connectors/manual-installation/powerbi"},{"title":"Revit","href":"/connectors/manual-installation/revit"},{"title":"Rhino \u0026 Grasshopper","href":"/connectors/manual-installation/rhino-grasshopper"},{"title":"SketchUp","href":"/connectors/manual-installation/sketchup"},{"title":"Tekla Structures","href":"/connectors/manual-installation/teklastructures"}]}],"global":{"anchors":[]}},{"dropdown":"Get Involved","icon":"users","groups":[{"group":"Ways to get involved","pages":[{"title":"User testing and feedback","sidebarTitle":"User Testing","href":"/get-involved/user-testing"},{"title":"Join the Speckle Community","sidebarTitle":"Community","href":"/get-involved/community"},{"title":"Open source at Speckle","sidebarTitle":"Open source","href":"/get-involved/open-source"}]}],"global":{"anchors":[]}},{"dropdown":"Changelog","icon":"history","pages":[{"title":"Changelog — November 2026","sidebarTitle":"November 2026","href":"/technical-changelog/2026-11"},{"title":"Changelog — October 2026","sidebarTitle":"October 2026","href":"/technical-changelog/2026-10"},{"title":"Changelog — September 2026","sidebarTitle":"September 2026","href":"/technical-changelog/2026-09"}],"global":{"anchors":[]}}]},"basePath":"","title":"Developers Guide - Speckle Docs","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":[],"chunks":[]}