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.
# Server API
The primary API of the Speckle Server is a GraphQL one.
The best way to explore and understand the Server API is to use our interactive explorer that come bundled with the server.
Any queries and mutations that you execute through the exploer will use the actual data from the server - take care!
Simply head to
YOUR-SERVER-ADDRESS/explorer, and on the right panel you'll be able to see the API docs and schemas. After logging in you'll also be able to execute queries and mutations as the logged in user.
# GraphQL Explorer
Alternatively, the classic GraphQL explorer is also available at
To authenticate, you will need to pass in a personal access token in the authorization header:
How do you create a token, we hear you ask? Read the section on personal access tokens!