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
Extraction, conversion, serialization, transport
Speckle exchanges objects, properties, and typed relations in a bundle, not opaque files:- Extraction — read native entities or files
- Conversion — map to objects keyed by
applicationId, property paths, geometry, and relations - Serialization — write the bundle with a bundle builder
- Transport — authenticate, open a model ingestion, upload the bundle; the server creates the version
Semantic data, geometry, and display values
- Semantic data — properties in the columnar property store
- Geometry — SGEO blobs; see Geometry encoding
- Display geometry — what the Viewer renders, attached through the
DISPLAYrelation; see Display geometry
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.