Introduction

Speckle server, frontend and viewer are hosted in our speckle-server (opens new window) repo.

To set up a local Speckle server for development, check out the Readme files in the git repo for a quick start, or the Local Setup page for detailed instructions.

To deploy a Speckle server on a non-production cloud environment, checkout the guide for deploying to Kubernetes or for deploying a DigitalOcean Droplet.

Server API

Our Speckle Server offers both a GraphQL API and a REST API, for most of your queries the GQL API is probably best suited because of its flexibility and ease of use. When working with uploading and downloading objects, the REST API is preferred.