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.
SDKs by integration need
| Need | Start here |
|---|---|
| Python scripts, agents, cloud jobs | specklepy · GitHub |
| .NET desktop connectors and converters | .NET SDK · speckle-sharp-sdk |
| JavaScript/TypeScript object graphs | @speckle/objectloader2 · @speckle/objectsender |
| Connector UI and converter patterns | speckle-sharp-connectors |
| Server API (projects, models, versions) | GraphQL API |
| Version events | Webhooks |
The TypeScript SDK is in development. For web connectivity, prefer GraphQL plus object loader and sender packages.
Open source reference implementations
Study structure and patterns—not host-specific conversion logic for a different product.Tekla Structures
.NET connector and converter patterns.
ETABS
CSI desktop integration in the connectors monorepo.
Blender
Python add-on connector example.
Power BI
Receive-only consumption app—data connector and 3D visual; no publish from Power BI. User guide: Power BI.
All .NET connectors
DUI, converters, and shared SDK usage.
Connectors overview
Install, publish, and load for shipped connectors.
Connector schemas
Per-host data shapes where documented.
Platform documentation
GraphQL API
Projects, models, versions, permissions.
REST API
REST endpoints where documented.
Data schema
Objects, collections, proxies, geometry.
Authentication
PATs, OAuth2, SSO.
NPM packages
- @speckle/objectloader2 — load and traverse object graphs
- @speckle/objectsender — send objects and create versions
- @speckle/ui-components — React UI (optional, for branded tools)
- @speckle/tailwind-theme — Tailwind theme
- speckle-auth — community auth utilities
Getting help
Community forum
Questions and discussion for developers.
GitHub
Source code, issues, contributions.
Discord
Real-time community chat.