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.
Choose your path
Pick the documentation track that matches what you are building:Connectivity
Host add-ins, connectors, send/receive, ETL, or middleware between Speckle and other tools.
Applications
Custom web apps, embedded viewer, dashboards, or Automate on Speckle data.
New to Speckle Development?
If you’re just getting started, we recommend this learning path:Understand the Data Model
Start with the Data Schema overview to understand how Speckle structures data
Set Up Authentication
Learn how to create and use Personal Access Tokens for API access
Learn the API
Explore the GraphQL API to understand how to interact with Speckle Server
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
Web applications
Custom web apps and embedded viewer—see Custom apps and the Viewer tab.
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.
Connectivity
Connectors, host add-ins, and middleware between Speckle and other applications.
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.
Quick Links
Custom apps
Guide to custom web applications on 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
- Authentication - Set up your access tokens
- Key Concepts - Understand Speckle’s fundamentals
- Connectivity - Connectors and integration pathways