LucidLink API Reference
The LucidLink API lets you programmatically manage your workspace: creating filespaces, browsing and managing entries, controlling members, groups, and permissions, and integrating external cloud storage via LucidLink Connect.
All endpoints are versioned under / and require a service-account bearer token. This reference is generated from the OpenAPI specification (version 1.5.0).
Resources
- — API liveness check. Returns 200 with an empty object when the server is responsive.
- — Create and manage filespaces (storage volumes) within your workspace.
- — Discover supported cloud storage providers and their available regions. Use this before creating a filespace with customer-owned storage.
- — Browse and manage the filespace filesystem: list directories, resolve paths, create directories, and delete entries.
- — Generate shareable links to filespace entries that open directly in the LucidLink app.
- — Manage service accounts — the non-human identities used to authenticate API calls. Create a service account (optionally with an initial key), list them, and delete them to revoke all of their keys.
- — Manage bearer-token keys for a service account. A key authenticates API requests — create one to get a token, delete it to revoke access. Keys can optionally be single-use or time-limited.
- — Manage workspace members: invite by email, update roles, and remove members.
- — Manage workspace groups for access control. Groups can be assigned filespace permissions.
- — Grant or revoke filesystem-level read/write access for members, groups, or service accounts on specific directory paths.
- — DataStores are S3 connection configurations for cloud storage. A DataStore holds the bucket name, access key, and secret key for a single S3 bucket. Files from the bucket can then be surfaced inside a filespace as ExternalEntries.
- — Present files from external S3 buckets or HTTP URLs directly inside a filespace. These appear as native entries to LucidLink clients.