Skip to main content

​
Lifecycle

​
new

Workspace.new(name: str, portal: Optional[Any] = None, description: Optional[str] = None) -> Workspace
Create a new workspace under the given (or resolved) portal. Parameters
​
name
str
required
​
portal
Optional[Any]
default:"None"
​
description
Optional[str]
default:"None"
Returns
​
returns
Workspace

​
get_or_create

Workspace.get_or_create(name: str, portal: Optional[Any] = None, description: Optional[str] = None) -> Workspace
Fetch by name, creating it if missing. Idempotent. Parameters
​
name
str
required
​
portal
Optional[Any]
default:"None"
​
description
Optional[str]
default:"None"
Returns
​
returns
Workspace

​
fetch

Workspace.fetch(id: Optional[str] = None, name: Optional[str] = None) -> Workspace
Fetch an existing workspace by id or name. Parameters
​
id
Optional[str]
default:"None"
​
name
Optional[str]
default:"None"
Returns
​
returns
Workspace

​
list

Workspace.list(limit: int = 50, offset: int = 0) -> WorkspaceList
List workspaces visible to the caller. Parameters
​
limit
int
default:"50"
​
offset
int
default:"0"
Returns
​
returns
WorkspaceList
See WorkspaceList.

​
update

Workspace.update(name: Any = UNSET, description: Any = UNSET) -> Workspace
Update the workspace’s name and/or description. Omitted fields are left unchanged. Parameters
​
name
Any
default:"UNSET"
​
description
Any
default:"UNSET"
Returns
​
returns
Workspace

​
delete

Workspace.delete() -> None

​
Documents

​
upload

Workspace.upload(*paths_or_files)
Upload one or more files (or folders) into this workspace’s data room. Parameters
​
*paths_or_files

​
Sessions

​
create_session

Workspace.create_session(documents=None)
Open a chat session for asking questions about this workspace’s documents. Parameters
​
documents
default:"None"

​
Types

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

​
WorkspaceList

Fields
​
workspaces
list[WorkspaceListEntry]
required
​
offset
int
required
​
limit
int
required
​
total
int
required

​
WorkspaceListEntry

Fields
​
id
str
required
​
name
str
required
​
description
str
required
​
portal_id
str
required