Overview
The LucidLink Python SDK is a developer-friendly library that brings LucidLink’s powerful file system and cloud storage capabilities directly into your Python applications. Instead of managing raw API calls, you get a clean, Pythonic interface to interact with your LucidLink filespaces, reading files, writing data, organizing directories, and connecting external cloud storage, all from your own code.
One of the most exciting things about the SDK is that it provides client-less access to your LucidLink environment. Your applications don’t need the LucidLink desktop client installed to work with filespace data. This opens the door to embedding LucidLink capabilities into backend services, automation pipelines, cloud functions, and any Python application — wherever Python runs.
The Python SDK is currently in beta. During the beta period, the SDK focuses on filesystem operations and LucidLink Connect (S3) capabilities. Workspace management features (user, group, and permission administration) are not included in the beta and will be added in a future release. Features, APIs, and behavior may change before general availability.
The Python SDK is part of our Developer Platform.
Getting started
Ready to start building with the LucidLink Python SDK? These resources will walk you through installation, authentication, and your first operations:
- Download the SDK
- View SDK examples
- Register for trial account (if you're not on the Business or Enterprise plans)
Prerequisites
Before you start using the Python SDK, make sure you have the following:
- Python 3.10 or later installed on your machine or in your application environment.
- A LucidLink account on app.lucidlink.com within a workspace that has access to service accounts (available on Trial, Business or Enterprise plans).
- A service account with an active secret key, used to authenticate SDK requests. Create one via your workspace's Service accounts page.
As a beta participant, your feedback is incredibly valuable to us. If you run into issues, have feature requests, or just want to share how you’re using the SDK, we’d love to hear from you. Reach out to your LucidLink account representative or contact our support team directly.
What can you do with the SDK?
The beta release of the Python SDK gives you two major areas of functionality: filesystem operations on your LucidLink filespaces, and LucidLink Connect integration for streaming external S3 assets (available during Trial and as an add-on for Enterprise plans).
Filesystem operations
The SDK lets you work with files and directories in your LucidLink filespaces just like you would with a local filesystem. This makes it easy to build scripts, services, and applications that manage filespace content programmatically.
| Read | Retrieve file contents and metadata from any path within your filespace. Stream large files efficiently without downloading entire objects upfront. |
| Write | Upload and write files to your filespace from your Python application. Populate project structures, generate reports, or sync data from external sources. |
| List | Enumerate files and subdirectories within any directory path. Build file manifests, audit content, or navigate filespace structures programmatically. |
| Delete | Remove files and empty directories from your filespace. Automate cleanup tasks, archive rotations, or decommission temporary project files. |
| Move | Relocate files and directories to new paths within your filespace. Reorganize project structures or implement naming convention changes at scale. |
| Copy | Duplicate files within your filespace. Create backups, set up template-based project structures, or distribute shared assets across directories. |
LucidLink Connect (S3 integration)
The SDK includes built-in support for LucidLink Connect, letting you link assets from your S3-compatible cloud storage directly into your filespaces. Linked files appear alongside your native filespace content and can be streamed by any LucidLink client — no copying or duplication required.
LucidLink Connect is available during Trial as well as for Enterprise workspaces that have purchased it as and add-on.
With the SDK, you can:
- Configure data stores — Securely connect your S3 buckets by providing access credentials that are encrypted and stored per-filespace.
- Link external objects — Map individual S3 objects to specific file paths in your filespace. Once linked, they’re instantly streamable from desktop, web, and mobile clients.
- Bulk import assets — Programmatically link large numbers of S3 objects into your filespace, perfect for migrating or onboarding large asset libraries.
- Manage data stores — List, update, and remove data store configurations as your infrastructure evolves.
During the beta, LucidLink Connect within the SDK supports S3-compatible storage only. Support for Azure Blob Storage and other providers will be added in future releases.
Why use the Python SDK?
The SDK is designed for teams and developers who want to go beyond manual file management and unlock the full potential of their LucidLink environment through code.
|
Embed into your applications Integrate LucidLink file operations directly into your products, services, or internal tools. The SDK acts as a native building block for any Python application that needs to interact with filespace data. |
Clientless access No LucidLink desktop client required. The SDK connects directly to your filespace via the API, making it ideal for servers, containers, CI/CD pipelines, and cloud-hosted applications where installing a desktop client isn’t practical. |
|
Automate file workflows Build scripts that organize, move, copy, and clean up filespace content on a schedule or in response to events. Replace manual drag-and-drop with reliable, repeatable automation. |
Bridge cloud storage Use LucidLink Connect through the SDK to unify your S3 assets with your filespace content. Your team gets a single, streamable view of all their files without data duplication. |
What’s included in the beta
To set clear expectations, here’s a summary of what’s available in the beta release and what we are thinking about for future iterations:
| Capability | Beta |
| Filesystem operations (read, write, list, delete, move, copy) | ✓ |
|
LucidLink Connect — S3 data stores and external entries (100k file limit w/1 TB storage) Available during Trial as well as for Enterprise workspaces that have purchased it LucidLink Connect as add-on. |
✓ |
| Clientless filespace access (no desktop client needed) | ✓ |
| Authentication via Service Account bearer tokens | ✓ |
| Workspace management (members, groups, permissions) | - |
| LucidLink Connect with Azure Blob Storage | - |
| Filespace provisioning and configuration | - |