Skip to main content
Applies to every architecture in this section. For the data model, see Object model. For the files a producer writes, see Build integrations on the bundle format. Before the steps below, decide publish only or publish and load for your host (receive-only is rare—mainly consumption apps like Power BI). See Publish & load for integration depth.

Projects, models, and versions

  • Project — groups work for a team or deliverable
  • Model — logical dataset (often per discipline or file)
  • Version — immutable snapshot after a send; design send, receive, and automation around versions
Workspaces and projects · API: Project · Model · Version

Extraction, conversion, serialization, transport

Speckle exchanges objects, properties, and typed relations in a bundle, not opaque files:
  1. Extraction — read native entities or files
  2. Conversion — map to objects keyed by applicationId, property paths, geometry, and relations
  3. Serialization — write the bundle with a bundle builder
  4. Transport — authenticate, open a model ingestion, upload the bundle; the server creates the version
Versions published before 2026.9 use an object graph of collections and proxies instead, described in the Data schema.

Semantic data, geometry, and display values

Write a display mesh for every object that renders, even when you also ship a solid, so viewers and downstream tools stay aligned.

Suggested build order

Skip steps that do not apply (for example receive-only integrations).
1

Authenticate

Use a PAT, OAuth2, or app credentials — Authentication.
2

Publish one object

Create a project and model, publish a one-object bundle, and confirm a version in the web app. See Publish a bundle or the Python quickstart.
3

Map metadata

Settle stable properties and applicationId values before you scale geometry.
4

Convert geometry

Convert the primitives your consumers need — Geometry encoding.
5

Design incremental updates

Define change sets (selection, delta, full resend) and version relationships for sync.
6

Tune performance

Stream rows, shard geometry, and deduplicate definitions — see the publish rules.
7

Add receive and update

For bidirectional flows, see Load a bundle and study the receive paths in speckle-sharp-connectors.
8

Package for deployment

Plan installers, logging, and updates — Manual installation for .NET connector patterns.

Architectures

Publish & load

Publish/load direction and integration depth.

Desktop host

Host add-ins and native desktop agents.

Cloud & automation

ETL, orchestration, and version-driven jobs.

Middleware

Enterprise orchestration between Speckle and other systems.

Hybrid

Multi-tier publish and consume patterns.
Last modified on October 19, 2026