Welcome to Speckle’s Developer Documentation! Here you’ll find everything you need to build on Speckle or connect Speckle to other applications and systems.Documentation Index
Fetch the complete documentation index at: https://docs.speckle.systems/llms.txt
Use this file to discover all available pages before exploring further.
What are you building?
Connectivity
Connect Speckle to or from desktop hosts, enterprise systems, or automation pipelines (connectors, add-ins, ETL, middleware).
Applications
Products on Speckle: web apps, embedded viewer, dashboards, Automate, and server deployment.
What Can You Build?
On Speckle (platform):- Custom applications — Web apps, visualizations, and tools using the viewer and data APIs
- Automate workflows — Serverless functions that process model data when new versions arrive
- Self-hosted server — Deploy and customize your own Speckle server instance
- Connectors and host add-ins — Send and receive between Speckle and CAD/BIM/structural applications
- Pipelines and middleware — Sync Speckle with databases, PLM, scheduling, or proprietary APIs
Quick Start
Getting Started
Your learning path to building with Speckle
Custom apps
Guide to custom web applications on Speckle
Authentication
Learn how to authenticate with Personal Access Tokens
Key Concepts
Understand Speckle’s fundamental concepts
Developer Resources
Connectivity
Connectors, host add-ins, and system integration pathways
Data Schema
Understand how Speckle organizes and structures AEC data
GraphQL API
Access Speckle Server’s GraphQL API for direct integrations
Python SDK
Full-featured SDK for building Python applications and scripts
Viewer API
Embed and customize the Speckle 3D viewer in your web applications
Server Deployment
Deploy and customize your own Speckle server instance
Speckle Automate
Create serverless functions that run automatically on model updates
NPM Packages
Use JavaScript/TypeScript packages for object loading and sending
Next Steps
Ready to start building? Check out these essential guides:- Getting Started - Your learning path and quick links
- Authentication - Set up your access tokens
- Key Concepts - Understand how Speckle works
- Connectivity - Connectors and integration pathways
Documentation Migration: We’re consolidating all Speckle documentation from speckle.guide to this new unified site. See our migration plan for details.