Shared State (Tandem Mode) Settings

👉 Follow the Share State Implementation Guide to learn how to expose and connect your app’s state to the SDK.

active

Enables or disables Tandem Mode (state sharing).
When true, the agent may read the page’s UI state (form values, visible fields, and component state) and can assist by suggesting or applying changes.

Type: boolean
Default Value: false

tooltipText

One-line hover label shown on the Agent control. Use this to clearly explain what toggling Tandem Mode does in a short,

Type: string
Default Value: "Allow the assistant to read the page to help complete tasks"

tooltipStarters

Array of up to 2 short suggested prompts shown in the UI to help users quickly start Tandem interactions.
Hints should be concise, actionable, and reassuring about consent. Use these as editable starter examples that guide users on how to interact with the agent.

Type: array
Default Value: [ "Fill out this form for me", "Suggest values for the fields on this page" ]