Skip to main content

Session Lifecycle

Sessions progress through these states:

Session Event Types


session.status

Query the current status and metadata of an active session.

session.validate

Validate that a session is properly configured and healthy.

session.get

Retrieve specific session configuration or state information.

session.modify

Modify session configuration or parameters while the session is running.

session.update

Update session state or trigger session processing.

session.read

Read pending events from the session’s event queue.
Unlike other session events, session.read returns immediately without waiting for a response.

session.destroy

Terminate an active session and free its allocated resources.
Only affects sessions in SESSION_STATUS_STARTING or SESSION_STATUS_RUNNING status.

Error Responses