Workspace reference

Lifecycle

`new`

Workspace.new(name: str, portal: Optional[Any] = None, description: Optional[str] = None) -> Workspace

async Workspace.anew(name: str, portal: Optional[Any] = None, description: Optional[str] = None) -> Workspace

Create a new workspace under the given (or resolved) portal. Parameters

str

required

Optional[Any]

default:"None"

Optional[str]

default:"None"

Returns

Workspace

`get_or_create`

Workspace.get_or_create(name: str, portal: Optional[Any] = None, description: Optional[str] = None) -> Workspace

async Workspace.aget_or_create(name: str, portal: Optional[Any] = None, description: Optional[str] = None) -> Workspace

Fetch by name, creating it if missing. Idempotent. Parameters

str

required

Optional[Any]

default:"None"

Optional[str]

default:"None"

Returns

Workspace

`fetch`

Workspace.fetch(id: Optional[str] = None, name: Optional[str] = None) -> Workspace

async Workspace.afetch(id: Optional[str] = None, name: Optional[str] = None) -> Workspace

Fetch an existing workspace by id or name. Parameters

Optional[str]

default:"None"

Optional[str]

default:"None"

Returns

Workspace

`list`

Workspace.list(limit: int = 50, offset: int = 0) -> WorkspaceList

async Workspace.alist(limit: int = 50, offset: int = 0) -> WorkspaceList

List workspaces visible to the caller. Parameters

int

default:"50"

int

default:"0"

Returns

WorkspaceList

See WorkspaceList.

`update`

Workspace.update(name: Any = UNSET, description: Any = UNSET) -> Workspace

async Workspace.aupdate(name: Any = UNSET, description: Any = UNSET) -> Workspace

Update the workspace’s name and/or description. Omitted fields are left unchanged. Parameters

Any

default:"UNSET"

Any

default:"UNSET"

Returns

Workspace

`delete`

Workspace.delete() -> None

async Workspace.adelete() -> None

Documents

`upload`

Workspace.upload(*paths_or_files)

async Workspace.aupload(*paths_or_files)

Upload one or more files (or folders) into this workspace’s data room. Parameters

Sessions

`create_session`

Workspace.create_session(documents=None)

async Workspace.acreate_session(documents=None)

Open a chat session for asking questions about this workspace’s documents. Parameters

default:"None"

Types

Configuration objects, response shapes, and enums used by the methods above.

`WorkspaceList`

Fields

list[WorkspaceListEntry]

required

int

required

int

required

int

required

`WorkspaceListEntry`

Fields

str

required

str

required

str

required

str

required

Get started

Guides

Pipeline

Agent

Knowledge Base

Integrations

Table

Transformation

Session

Analytics

Workspace

Lifecycle

`new`

`get_or_create`

`fetch`

`list`

`update`

`delete`

Documents

`upload`

Sessions

`create_session`

Types

`WorkspaceList`

`WorkspaceListEntry`

​Lifecycle

​new

​get_or_create

​fetch

​list

​update

​delete

​Documents

​upload

​Sessions

​create_session

​Types

​WorkspaceList

​WorkspaceListEntry

Lifecycle

`new`

`get_or_create`

`fetch`

`list`

`update`

`delete`

Documents

`upload`

Sessions

`create_session`

Types

`WorkspaceList`

`WorkspaceListEntry`