Migrate a Speckle.Sdk script to 2026.9

​

What changes for a script

​

Update packages

dotnet add package Speckle.Sdk --version 2026.9.0-beta.7

<PackageReference Include="Speckle.Sdk" Version="2026.9.0-beta.7" />

​

Load a model

• Prior to 2026.9 (Receive2)
• 2026.9 (Receive3)

Prior to 2026.9

var root = await SpeckleBootstrap.Operations.Receive2(
    client.ServerUrl,
    projectId,
    latest.referencedObject!,
    account.token,
    onProgressAction: null,
    cancellationToken: default
);

2026.9

using var model = await SpeckleBootstrap.Operations.Receive3(
    account,
    projectId,
    modelId,
    latest.id,
    options: null,
    cancellationToken: default
);

​

Count and filter objects

• Prior to 2026.9
• 2026.9

Prior to 2026.9

var counts = root.Flatten()
    .OfType<DataObject>()
    .GroupBy(d => d.properties.GetValueOrDefault("category") as string ?? "Unknown");

var byLevel = root.Flatten()
    .OfType<DataObject>()
    .GroupBy(d => d.properties.GetValueOrDefault("level")?.ToString() ?? "Unknown");

var walls = root.Flatten()
    .OfType<DataObject>()
    .Where(d => d.properties.GetValueOrDefault("category") as string == "Walls");

2026.9

var counts = model.Objects.GroupBy(o => o.GetString("category") ?? o.Name ?? "Unknown");

var byLevel = model.Objects.GroupBy(o => o.Level?.Name ?? "Unknown");

var walls = model.ObjectsWith("category").Where(o => o.GetString("category") == "Walls");

​

Replace property walks

• GetString / GetDouble / GetBool: typed lookup. Null if the path is missing or the value is another type.
• Under("Constraints"): the subtree under that prefix, with the prefix stripped. No allocation.
• Indexer / TryGetValue: untyped lookup, same paths as GetString.
• ToNested(): the old nested-dictionary tree. Allocates. Use it only when a caller still needs that shape.

• Prior to 2026.9
• 2026.9

Prior to 2026.9

var wall = root.Flatten().OfType<DataObject>().First();
var groups = wall.properties.GetValueOrDefault("parameters") as Dictionary<string, object?>;
var x = groups?.GetValueOrDefault("x") as Dictionary<string, object?>;
var y = x?.GetValueOrDefault("y");

2026.9

var wall = model.Objects.First();
var y = wall.GetString("parameters.x.y");
var offset = wall.GetDouble("Constraints.Base Offset");

var constraints = ((PropertyView)wall.Properties).Under("Constraints");
foreach (var kv in constraints)
{
    Console.WriteLine($"{kv.Key}: {kv.Value}");
}

​

Replace proxy walks

2026.9

var byLevel = model.Objects.GroupBy(o => o.Level?.Name ?? "Unknown");
var hosted = model.Objects.Where(o => o.Host is not null);

​

Read versions published before 2026.9

• Versions published before 2026.9: pass referencedObject as a content hash and get the object graph back.
• Versions published in 2026.9: referencedObject is a bundle reference (bundle.<projectId>.<modelId>.<versionId>). A 2026.9 SDK recognizes the prefix and returns a best-effort Base tree (DataObject idiom, version = 4 on the root). That projection does not scale to the model sizes the bundle format is built for, and it is not a lossless round trip. Do not build new work on it.
• Older SDKs: fetching a bundle reference from the objects API returns 404 with upgrade guidance. Update Speckle.Sdk rather than parsing the 404 body.

​

Publish from a script

2026.9

using Speckle.Objects.Geometry;
using Speckle.Sdk;
using Speckle.Sdk.Bundles;

using var builder = new BundleBuilder(
    new SpeckleApplication
    {
        HostApplication = "My Script",
        HostApplicationVersion = "1.0",
        Slug = "my-script",
        SpeckleVersion = "1.0.0",
    },
    "m"
);

var walls = builder.GetOrAddContainerPath(["Walls"]);
var wall = builder.GetOrAddObject("wall-1").SetProperties(
    new Dictionary<string, object?> { ["Mark"] = "W-01" },
    name: "Basic Wall"
);
wall.Collection = walls;
wall.AddGeometry(new Mesh { vertices = [0, 0, 0, 1, 0, 0, 0, 1, 0], faces = [3, 0, 1, 2], units = "m" });

var sent = await SpeckleBootstrap.Operations.Send3(account, projectId, modelId, builder, options: null, cancellationToken: default);
var version = await SpeckleBootstrap.Operations.WaitForVersion(account, sent);

​

FAQ