Skip to main content
A Portal groups related workspaces together and exposes the agents and skills available to them. Create workspaces under a portal with portal.workspaces.new(...) or portal.workspaces.get_or_create(...), and list them with portal.workspaces.list().

​
Lifecycle

​
new

Portal.new(name: str, description: Optional[str] = None, deployed: Optional[bool] = None, features: Optional[dict] = None, deployment_options: Optional[dict] = None, access_config: Optional[dict] = None, tabs: Optional[list] = None, default_chatbot_id: Optional[str] = None) -> Portal
Create a new portal. Parameters
​
name
str
required
​
description
Optional[str]
default:"None"
​
deployed
Optional[bool]
default:"None"
​
features
Optional[dict]
default:"None"
​
deployment_options
Optional[dict]
default:"None"
​
access_config
Optional[dict]
default:"None"
​
tabs
Optional[list]
default:"None"
​
default_chatbot_id
Optional[str]
default:"None"
Returns
​
returns
Portal

​
fetch

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

​
list

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

​
update

Portal.update(description: Any = UNSET, deployed: Any = UNSET, features: Any = UNSET, deployment_options: Any = UNSET, access_config: Any = UNSET, tabs: Any = UNSET) -> Portal
Update the portal’s settings. Omitted fields are left unchanged. Parameters
​
description
Any
default:"UNSET"
​
deployed
Any
default:"UNSET"
​
features
Any
default:"UNSET"
​
deployment_options
Any
default:"UNSET"
​
access_config
Any
default:"UNSET"
​
tabs
Any
default:"UNSET"
Returns
​
returns
Portal

​
delete

Portal.delete() -> None

​
Agents & skills

​
agents

Portal.agents()
Org agents, if this portal enables agent projects (else []).

​
agent

Portal.agent(name: Optional[str] = None)
Resolve a single agent by name, or the only one when name is None. Parameters
​
name
Optional[str]
default:"None"

​
skills

Portal.skills()
Org skills, if this portal enables skills (else []).

​
Sessions

​
create_session

Portal.create_session()
Open a session on the portal’s default chatbot.

​
Types

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

​
PortalList

Fields
​
portals
list[PortalListEntry]
required
​
offset
int
required
​
limit
int
required
​
total
int
required

​
PortalListEntry

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

​
SkillList

Fields
​
skills
list[SkillEntry]
required
​
offset
int
required
​
limit
int
required
​
total
int
required

​
SkillEntry

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