Skip to main content
This package sends object graphs, the publish format before 2026.9, and the server converts each one to a bundle before the version appears. That path is superseded: for new work, see Writing data.

Overview

@speckle/objectsender is a JavaScript/TypeScript package for sending Speckle objects to Speckle Server. It serializes an object graph, uploads it to a project, and returns the id of its root object. You then create a version that points at that id. Package: @speckle/objectsender on npm Creating the version returns a reserved id, not a version you can read yet. Wait for the conversion to finish before you query or link it; see Publish through model ingestions. A server without legacy-send support rejects object-graph publishes with LEGACY_SEND_UNSUPPORTED. Consumers read the converted version as a bundle.

Installation

Quick Start

Then create a version on a model with the returned hash as its objectId, through the versionMutations.create GraphQL mutation:
Variables

Features

  • Send objects to Speckle Server
  • Handle object serialization
  • Detach and chunk large properties with the Detach and Chunkable decorators
  • Support for large object hierarchies

Documentation

For complete documentation, examples, and API reference, visit the package on npm: View on npm →
Last modified on October 19, 2026