PersistentAI API Documentation / @persistentai/fireflow-vfs / / Workspace

Interface: Workspace

Defined in: packages/fireflow-vfs/src/types/workspace.ts:57

VFS Workspace - maps to a lakeFS repository

Properties

createdAt

createdAt: Date

Defined in: packages/fireflow-vfs/src/types/workspace.ts:81

Creation timestamp

---

defaultBranch

defaultBranch: string

Defined in: packages/fireflow-vfs/src/types/workspace.ts:77

Default branch name

---

description?

optional description: string

Defined in: packages/fireflow-vfs/src/types/workspace.ts:63

Optional description

---

id

id: string

Defined in: packages/fireflow-vfs/src/types/workspace.ts:59

Unique workspace ID (WS + 20 alphanumeric chars)

---

lakeFSRepoName

lakeFSRepoName: string

Defined in: packages/fireflow-vfs/src/types/workspace.ts:65

lakeFS repository name (internal, never exposed via API)

---

name

name: string

Defined in: packages/fireflow-vfs/src/types/workspace.ts:61

Display name

---

ownerId

ownerId: string

Defined in: packages/fireflow-vfs/src/types/workspace.ts:67

FireFlow user ID of the owner (for user workspaces)

---

ownerRef?

optional ownerRef: string

Defined in: packages/fireflow-vfs/src/types/workspace.ts:71

External reference for the owner (userId for users, flowId for flows, etc.)

---

ownerType

ownerType: "flow" | "user" | "team" | "system"

Defined in: packages/fireflow-vfs/src/types/workspace.ts:69

Owner type (user, flow, team, system)

---

settings

settings: WorkspaceSettings

Defined in: packages/fireflow-vfs/src/types/workspace.ts:79

Workspace settings

---

slug

slug: string

Defined in: packages/fireflow-vfs/src/types/workspace.ts:73

URL-safe workspace slug (default: 'default')

---

updatedAt

updatedAt: Date

Defined in: packages/fireflow-vfs/src/types/workspace.ts:83

Last update timestamp

---

visibility

visibility: WorkspaceVisibility

Defined in: packages/fireflow-vfs/src/types/workspace.ts:75

Visibility level