Skip to main content
This REST API reference is for developers who need direct access to REST endpoints. Most use cases are better served by the SDKs or the GraphQL API, which handle authentication, retries, and the version formats for you.
Use the SDKs first and the GraphQL API second. Calling the REST endpoints directly leaves error handling, batching, and format checks to you, and mistakes there can leave orphaned objects behind.

Which endpoints your server has

Speckle runs as Speckle Cloud, as Speckle Enterprise Server, and as the open-source Speckle Server. Not every endpoint exists on all three: The open-source server does not support 2026.9, so it has no bundle versions; see Server introduction.

Authentication

Send a personal access token as a bearer token:
Create one in your Speckle profile settings with the streams:read scope for the read endpoints. Reads on a public project need no token. For any other project, the token’s user needs read access to it.

Base URL

Paths in this reference are relative to your server’s address:
For a self-hosted server, replace that with your server’s address. Some paths start with /api and the object endpoints do not; use each path as written.

Object endpoints

These are listed under Object endpoints (legacy) in the navigation, with a deprecated label.
  • [Get Single Object](GET /objects///single): download a single object without its children
  • [Get Object with Children](GET /objects//): download an object and all of its children recursively
These endpoints serve object graphs. On Speckle Cloud and Speckle Enterprise Server 2026.9 and later they are deprecated, and every response carries Deprecation and Warning headers. A bundle version’s referencedObject (bundle.<projectId>.<modelId>.<versionId>) sent to them returns 404 with error: "BUNDLE_REFERENCE_NOT_FOUND". Treat that as “this version is a bundle”, never as an empty model, and read it with the bundle endpoints.
The object upload, batch download, and existence-check (/api/diff) endpoints are not listed here: write with the SDKs or the GraphQL API. On Speckle Cloud, publish through ingestions. Speckle Cloud removes /api/diff on 26 November 2026.

Bundle endpoints

A version is either a bundle or an object graph (published before 2026.9, or by an older connector). Read a bundle version from its files:
  • [List a Version’s Bundle Files](GET /api/v2/projects//models//versions//artifacts): Presigned URLs, valid for one hour, to every file of the version’s bundle
  • [List a Model’s Latest Bundle Files](GET /api/v2/projects//models//artifacts): The same, for the model’s latest version
Fetch the presigned URLs without the Authorization header. Match files by the end of their names, such as .eav.eav.parquet. How to read the properties from them is in Get element data from a version. For Power Automate, Zapier, or n8n, which cannot read Parquet, see Use model properties in low-code tools. The full bundle load sequence is in Load a bundle in your own code.

Properties export

The properties export returns a version’s properties table, one row per property:
  • [Export a Version’s Properties](POST /api/v1/projects//models//versions//eav/query): As JSON, CSV, or Parquet ({"format": "json"})
  • [Download a Version’s Properties Database](GET /api/v1/projects//models//versions//eav/download): The same table as a DuckDB database
  • [Download a Model’s Latest Properties Database](GET /api/v1/projects//models//eav/download): The same, for the model’s latest version
The export serves bundle and object-graph versions in the same columns. With {"format": "json"} it returns an array of rows:
It always returns the whole table. To read only some properties of a bundle version, read its eav files with the bundle endpoints. The two downloads serve object-graph versions only: for a bundle version they return 404 with "Version not found or has no EAV artefact".

Interactive API playground

Each endpoint page includes a playground where you can send requests from your browser, using the authentication and server settings above.
Last modified on November 17, 2026