Skip to main content
This REST API reference is provided for developers who need direct access to REST endpoints. However, we strongly recommend using our SDKs or the GraphQL API instead, as they provide safeguards against common mistakes and a more intuitive developer experience.

​
Overview

We strongly recommend using our SDKs first, and the GraphQL API second, before considering the REST API.While the REST API is fully stable, using it directly presents many opportunities for user error that can lead to undesirable outcomes such as zombie objects. The SDKs provide a safer, more intuitive interface with proper error handling and safeguards, while the GraphQL API offers better flexibility and type safety than raw REST endpoints.
Our Speckle Server offers both a GraphQL API and a REST API. This REST API documentation is provided for reference purposes only. Most use cases are better served by our SDKs or the GraphQL API.

​
Authentication

All REST API endpoints require authentication using a personal access token. Include it in your requests: 
Authorization: Bearer YOUR_TOKEN
Get your personal access token from your Speckle profile settings. For self-hosted instances, replace the domain with your server’s address.

​
Base URL

The base URL format is: 
https://YOUR_SERVER_URL/api
For Speckle Cloud, use: 
https://app.speckle.systems

​
Available Endpoints

The following GET endpoints are documented below. Each endpoint page includes detailed request/response schemas, examples, and an interactive API playground:
  • [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
POST endpoints have been removed from this documentation. For uploading objects and other write operations, please use our SDKs or the GraphQL API.

​
Interactive API Playground

Each endpoint page includes an interactive API playground where you can test requests directly in your browser. The playground uses the authentication and server configuration from the OpenAPI specification.