Skip to main content
This SDK is for people who want to automate AEC workflows with C# using Speckle. You do not need to be a professional software engineer to build useful tools with it. Likely readers include:
  • 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
Speckle.Sdk (SpeckleSharp) lets your C# code talk to Speckle Server — load published model versions, query objects by their properties and relations, export CSV reports, and optionally publish results back. It works from console apps, Grasshopper scripts, notebooks, and desktop plugins.
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.
GitHub Repository
Speckle.Sdk is reliable for production use, but the public API may not be wholly stable between releases. Pin a specific NuGet version and review release notes before upgrading.

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:
  1. Authenticate
  2. Choose a project and model
  3. Load a version
  4. Query objects and their properties
  5. Analyse or transform data
  6. Optionally publish results back
The full mental model and diagram live in Core concepts. The data model behind a version is on Object model.
The recommended approach for most AEC automation scripts: PAT via environment variable → Receive3 on the latest version → query model.Objects → analyse → optional Send3.

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 notebooks

Migrate to 2026.9

Move a Receive2 script to Receive3, side by side

Use 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 script

FAQ

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.
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.
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.
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
Last modified on October 19, 2026