Skip to main content

​
Interface: StartSessionOptions

Defined in: Options for starting a new session.

​
Properties

​
externalId?

Defined in: (Optional) An external identifier for the session. If a session with this external ID already exists, it will be reused instead of creating a new session.

​
metadata?

Defined in: (Optional) User metadata for the session as key-value string pairs. Only applied when creating a new session.

​
name?

Defined in: (Optional) The name of the session. Only applied when creating a new session.

​
previousSessionId?

Defined in: (Optional) The ID of a previous session to link to. Creates a reference only; does not inherit metadata. Only applied when creating a new session.