Skip to main content

​
New to Speckle Development?

If you’re just getting started, we recommend this learning path:
1

Understand the Data Model

Start with the Data Schema overview to understand how Speckle structures data
2

Set Up Authentication

Learn how to create and use Personal Access Tokens for API access
3

Learn the API

Explore the GraphQL API to understand how to interact with Speckle Server
4

Choose Your Tool

Pick the right tool for your use case (see options below)
5

Follow the Quickstart

Each section has a quickstart guide to get you up and running in minutes

​
Choose Your Development Tool

Pick the right tool based on your use case:

Python Workflows

Use the Python SDK for data processing, ETL pipelines, and automation scripts

Web Applications

Use the Viewer API to embed interactive 3D models in your web applications

Direct API Access

Use GraphQL directly for custom integrations and fine-grained control

Automation

Use Speckle Automate for serverless functions that run on model updates

Self-Hosting

Deploy your own Speckle server for complete control over your infrastructure

JavaScript/TypeScript

Use NPM packages for object loading, sending, and viewer integration

​
Common Use Cases

Building Web Applications

Use the Viewer API to embed interactive 3D models in your web applications. Perfect for dashboards, presentations, and custom visualization tools.

Data Pipelines & ETL

Use the Python SDK to extract, transform, and load data between applications. Build custom data processing workflows.

Automated Analysis

Create Automate functions that run structural analysis, code compliance checks, or generate reports automatically.

Custom Integrations

Connect Speckle to your internal tools, databases, or third-party services using our APIs and SDKs.

Robotics & 3D Printing

Stream geometry data directly to manufacturing systems, 3D printers, or robotic fabrication tools.

Machine Learning

Extract and process AEC data for training models, running predictions, or generating insights.

Building Custom Apps

Complete guide to building web applications with Speckle

Python SDK Quickstart

Get started with Python in 5 minutes

Viewer Quickstart

Embed a 3D viewer in your app

Automate Quickstart

Create your first automation

​
Next Steps