Session object used when a chat app is running

orgId
string
required

The id of the organisation that the session belongs to (usually the teamId of the corresponding app object).

teamId
string
required

The id object of the team the session belongs to (usually the teamId of the corresponding app object the session stems from).

name
string
required

The name of the session

startDate
object
required

Date object of when the session was started.

lastUpdatedDate
object
required

Date object of when the session was last updated.

tokensUsed
integer
required

The number of AI tokens used in this session.

status
enum<string>
required

The cuurent state of the session

Available options:
started,
running,
waiting,
warning,
error,
terminated
sharingConfig
object
required

While the permissions object is intended to hold permissions presence in the permissions object as a key implies view/read access for now until we implement checks and update middleware chains for more complex permissions. Keys are intended to be user, team, or org IDs with a mapping to permissions.

_id
string

Mongodb Object id, unique identifier, length of 24 characters fitting the following regex; [a-f0-9]{24}

appId
string

The appId of the app that the session is running

previewLabel
string

Label to show when previewing the session