Skip to main content

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.

When to use: A desktop connector or agent publishes data; cloud jobs or other services consume the same project, model, and version identifiers—often alongside a separate web product for viewing or workflows.

Typical boundaries

  1. Extract and convert in the host — see Desktop host
  2. Serialize and transport via SDK — create a Speckle version
  3. Consume downstream — cloud jobs (Cloud & automation), middleware (Middleware), or UI in Applications (Custom apps, Viewer)
The browser/UI layer is usually Applications documentation, not a connectivity architecture on its own. Keep host and cloud boundaries explicit so teams do not duplicate viewer logic inside connectors.

Stacks by tier

TierTypical technologyDocumentation
Host.NET connector, speckle-sharp-sdkDesktop host
TransportGraphQL, specklepy operationsGraphQL API
Cloud processingspecklepy, webhooksCloud & automation
Web UIViewer, custom appsCustom apps
Last modified on May 19, 2026