Skip to main content
specklepy is the Python SDK for Speckle. Use it to load published models into scripts and notebooks, query their objects, properties, and relations, publish results back, and build custom integrations for the AEC industry.
New to Speckle SDKs? Start with the shared SDK introduction for platform concepts and how Python and .NET relate.
Moving a script written for operations.receive and a Base-tree walk? Follow Migrate to 2026.9 for side-by-side changes.
GitHub Repository

Quick Start

Get up and running in 5 minutes

Migrate to 2026.9

Move an existing script to receive3

API Reference

Explore the complete API
Complete API documentation: for detailed, auto-generated API reference documentation, visit the specklepy API Documentation.

What is specklepy?

specklepy is a Python library that provides:
  • Model loading - Load a version as a queryable Model: objects, path-keyed properties, and typed relations (operations.receive3)
  • Publishing - Describe objects and geometry in code and publish them as a new version (operations.send3)
  • GraphQL API client - Full access to Speckle Server’s API: projects, models, versions, and more
  • Geometry support - Geometric primitives (Point, Line, Mesh, Brep, and more)
  • Object-graph tools - Base objects and transports for versions published before 2026.9
specklepy requires Python 3.11+ and supports Windows, macOS, and Linux.

Key Features

Query models, not files

Speckle stores model data as objects with properties and relations, not files. Load a version and query it directly.
Speckle stores sets of objects in Models. Models are contained within Projects. Projects are contained within Workspaces. Learn more about organising your data in Speckle in the User Guide. How the data inside a version is shaped: Object model.

Version Control for AEC Data

Every publish creates a new version, giving you full history and traceability.

Real-Time Collaboration

Subscribe to changes and get notified when new data arrives.
Subscriptions may not make sense if the script is not running continuously. Consider using a webhook or a scheduled task instead.

Common Use Cases

Custom Python backed web applications

Extract data from one application (e.g., Revit) and load it into another that may have a python scripting interface and no Speckle Connector.

Automated Workflows

Within Speckle Automation or your own automation pipelines that process AEC data, run analyses, or generate reports.

Custom Integrations

Connect Speckle to your internal tools, databases, applications with a python scripting environment, or third-party services.

Data analysis

Group, filter, and aggregate model properties in notebooks with pandas or similar tools.

Installation

Install specklepy with the bundle extra:
An older specklepy gets a 404 when it loads a version published by a 2026.9 connector. Install 2026.9.0b3 or later with the bundle extra. See Who’s affected.
2026.9.0b3 is a prerelease; a later stable 2026.9.0 replaces the pin without changing the calls. For virtual environments and other options, see the Installation Guide.

Quick Example

Load the latest version of a model and count its objects by category:

Next Steps

Installation

Install specklepy and set up your environment

Authentication

Learn how to authenticate with Speckle Server

Quickstart

Build your first integration

Migrate to 2026.9

Update an existing operations.receive script

Getting Help

Community Forum

Ask questions and share knowledge

GitHub Issues

Report bugs and request features
Last modified on November 14, 2026