Share Current Tab Settings

Allows the SDK to read and interpret the page’s content, providing the agent with full awareness of the page’s structure and elements. This enables the agent to guide users contextually based on what’s happening on the page.

active

Enables or disables the Shared Current Tab feature. When true, the agent can read and understand the content of the current page to provide contextual assistance, suggest actions, or highlight relevant information without making any changes directly.

• Type: boolean
• Default Value: false

tooltipText

One-line hover label shown on the Agent control. Use this to clearly explain what enabling Shared Current Tab does in a short, non-technical way that reassures users about control and privacy.

• Type: string
• Default Value: "Let the assistant understand this page and help you."

tooltipStarters

Array of up to 2 short suggested prompts shown in the UI to help users quickly start interactions using Shared Current Tab. Hints should be concise, actionable, and reassure users that the agent only reads the page to assist, without modifying it.

• Type: array
• Default Value: [ "Summarize this", "Explain what I'm seeing" ]

shareMode

Determines what type of data the SDK includes when the user shares their screen with the agent. This controls whether the agent receives only an image of the page, only its HTML structure, or both.

• Type: "image" | "html" | "both"
• Default Value: "both"

Example

foldspace.agent('API-KEY').setConfiguration({
  screenSharingSettings: {
    active: true,
    tooltipText: "Allow the assistant to understand this page and provide helpful suggestions",
    tooltipStarters: [
      "Summarize this page for me",
      "Highlight important information here"
    ],
    shareMode: "both"
  }
});