FlowEngine Session IDInstall

Summary

Generate or manage Session IDs for AI Agent workflows to maintain consistent or new session identifiers across workflow executions.

Inputs

• Mode (required) — Select how to handle the Session ID generation: either generate a new UUID v4 for each execution or manage a persistent ID across multiple loop iterations using workflow static data.
• Session Key — When using 'Manage Loop Session' mode, provide a key to store and retrieve the session ID from workflow static data.
• Reset Session — When using 'Manage Loop Session' mode, choose whether to force generate a new session ID, replacing any existing one.

Output shape

A list of items matching the input count, each containing a JSON object with a 'sessionId' string property. If the input item has binary data, it is preserved in the output item.

The session ID is a UUID v4 string. In 'Generate New ID' mode, each item receives a freshly generated UUID. In 'Manage Loop Session' mode, the same session ID is persisted and reused based on the given Session Key, unless 'Reset Session' is set to true to regenerate it. Errors related to missing session keys or invalid modes are returned per item if 'Continue On Fail' is enabled; otherwise, execution stops.

Examples

Example 1: Generate a new fresh UUID v4 for each input item execution to uniquely identify sessions without persistence.

Set 'Mode' to 'Generate New ID'. The node outputs a new 'sessionId' per item.

Example 2: Manage a persistent session ID across multiple loop iterations within a workflow to maintain context.

Set 'Mode' to 'Manage Loop Session', set 'Session Key' to a unique identifier string (e.g., 'myAgentSession'), and optionally enable 'Reset Session' to generate a new ID. The session ID is stored in static workflow data and reused.