Portal reference

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

async Portal.anew(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

str

required

Optional[str]

default:"None"

Optional[bool]

default:"None"

Optional[dict]

default:"None"

Optional[dict]

default:"None"

Optional[dict]

default:"None"

Optional[list]

default:"None"

Optional[str]

default:"None"

Returns

Portal

`fetch`

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

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

Fetch an existing portal by id or name. Parameters

Optional[str]

default:"None"

Optional[str]

default:"None"

Returns

Portal

`list`

Portal.list(limit: int = 50, offset: int = 0) -> PortalList

async Portal.alist(limit: int = 50, offset: int = 0) -> PortalList

List portals visible to the caller. Parameters

int

default:"50"

int

default:"0"

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

async Portal.aupdate(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

Any

default:"UNSET"

Any

default:"UNSET"

Any

default:"UNSET"

Any

default:"UNSET"

Any

default:"UNSET"

Any

default:"UNSET"

Returns

Portal

`delete`

Portal.delete() -> None

async Portal.adelete() -> 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

Optional[str]

default:"None"

`skills`

Portal.skills()

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

Sessions

`create_session`

Portal.create_session()

async Portal.acreate_session()

Open a session on the portal’s default chatbot.

Types

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

`PortalList`

Fields

list[PortalListEntry]

required

int

required

int

required

int

required

`PortalListEntry`

Fields

str

required

str

required

str

required

`SkillList`

Fields

list[SkillEntry]

required

int

required

int

required

int

required

`SkillEntry`

Fields

str

required

str

required

str

required

Get started

Guides

Pipeline

Agent

Knowledge Base

Integrations

Table

Transformation

Session

Analytics

Workspace

Lifecycle

`new`

`fetch`

`list`

`update`

`delete`

Agents & skills

`agents`

`agent`

`skills`

Sessions

`create_session`

Types

`PortalList`

`PortalListEntry`

`SkillList`

`SkillEntry`

​Lifecycle

​new

​fetch

​list

​update

​delete

​Agents & skills

​agents

​agent

​skills

​Sessions

​create_session

​Types

​PortalList

​PortalListEntry

​SkillList

​SkillEntry

Lifecycle

`new`

`fetch`

`list`

`update`

`delete`

Agents & skills

`agents`

`agent`

`skills`

Sessions

`create_session`

Types

`PortalList`

`PortalListEntry`

`SkillList`

`SkillEntry`