- Architects using Grasshopper C# nodes
- BIM managers automating QA checks
- Engineers extracting model data
- Computational designers building custom workflows
- AEC developers building plugins or integrations
- AI-assisted coders using Cursor, Claude, ChatGPT, or similar tools
New to Speckle SDKs? Start with the shared SDK introduction for
platform concepts and how Python and .NET relate.
Moving a script written for
Receive2 and Flatten()? Follow Migrate to
2026.9 for side-by-side changes.How most workflows run
Your code uses SpeckleSharp to talk to Speckle Server. Speckle Server stores projects, models, and versions; each version holds the model’s objects, their properties, and the relations between them. In practice, most useful workflows follow this pattern:- Authenticate
- Choose a project and model
- Load a version
- Query objects and their properties
- Analyse or transform data
- Optionally publish results back
The full mental model and diagram live in Core
concepts. The data model behind a version is on
Object model.
Choose your path
Build your first model analysis tool
Load a model, count elements by category, export a CSV report — end to end
Automate with scripts
Copy-paste bootstrap and
Receive3 for console apps and notebooksMigrate to 2026.9
Move a
Receive2 script to Receive3, side by sideUse SpeckleSharp in Grasshopper C#
Custom analysis and computed metadata in a C# Script component
What you can do with SpeckleSharp
Under the hood, SpeckleSharp exposes typed APIs (
IClient, IOperations, Model, ModelObject) — you meet them in the guides after you know the outcome you want.
API reference pages are for method lookup after you have a working script. Start with Build
your first model analysis
tool, not the API index.
Speckle.Sdk targets netstandard2.0, net8.0, and net10.0, so it runs in modern .NET
apps and older host apps such as Revit on .NET Framework.
Common use cases
BIM QA checks
Verify required properties exist, find duplicate element IDs, flag missing fire ratings
Schedules and reports
Export room schedules, door lists, or quantity takeoffs by level or category to CSV
Grasshopper analysis
Derive metadata from geometry, combine Speckle model data with Grasshopper logic
Version comparison
Compare two model versions to see what was added, removed, or changed
One-time setup
Speckle.Sdk uses dependency injection internally so connectors can share a container with host apps. For scripts and notebooks: paste the bootstrap from Automate with scripts once — you do not need to study DI. Connectors and services: see Dependency injection (connectors).Installation
2026.9.0-beta.7 is a prerelease; a plain
dotnet add package Speckle.Sdk installs 2026.8, which
has no Receive3. A later stable 2026.9.0 replaces the pin without changing the calls. For target
framework details, see Installation.Next Steps
Build your first model analysis tool
End-to-end CSV report from a live model
Core concepts
Projects, models, versions, and the SpeckleSharp mental model
Migrate to 2026.9
Update an existing
Receive2 scriptFAQ
Where should I start?
Where should I start?
Build your first model analysis
tool if you want a
complete working script. Automate with
scripts if you only need the
bootstrap snippet. Publish and load a model from
C# if you want to publish your own data
from scratch.
My script uses Receive2. Can I keep it?
My script uses Receive2. Can I keep it?
No, not for new work. Update to Speckle.Sdk 2026.9.0-beta.7 and load with
Receive3: older
builds get a 404 on versions from a 2026.9 connector, and Speckle does not guarantee they keep
working against current servers. Keep Receive2 only to read versions published before 2026.9.
See Migrate to 2026.9.Do I need to learn dependency injection?
Do I need to learn dependency injection?
No for scripts and notebooks — paste the bootstrap once and resolve
IOperations and
IClientFactory. Read Dependency injection
(connectors) only if you build a
connector or share a DI container with a host app.Is the public API stable?
Is the public API stable?
Speckle.Sdk is reliable for production use, but the public API may change between releases. Pin
an explicit NuGet version and review release notes before upgrading.
Getting Help
Community Forum
Ask questions and share knowledge
GitHub Issues
Report bugs and request features