Embed Sigma Assistant (Deprecated)

Embedding Sigma Assistant as a standalone experience is deprecated and will reach end of support on March 16, 2027.

You can embed the Sigma Assistant interface, which offers your users the ability to ask natural language queries of data, into your own application or website.

For more about Sigma Assistant, see Ask natural language queries with Sigma Assistant.

Migrate embedded Sigma Assistant

If you embed Sigma Assistant, migrate to an alternative setup before embedding Sigma Assistant is no longer supported. Instead of embedding Sigma Assistant as a standalone experience, consider one of the following options:

Embed a Sigma agent chat element (Beta)

Embed just the chat element for the same standalone experience as embedding Sigma Assistant.
Trade minimal setup for full control over the agent’s data sources, instructions, tools, and greeting.

Embed Sigma Assistant in a workbook (Beta)

Reuse your existing Sigma Assistant setup, but embed an entire workbook instead of a standalone interface.
Keeps the same data source and permission behavior as embedding Sigma Assistant today.

The following table compares embedding Sigma Assistant as a standalone experience with the two migration options:

	Embed Sigma Assistant (deprecated)	Embed a Sigma agent chat element (Beta)	Embed Sigma Assistant in a workbook
Setup effort	Minimal. Select data sources for Assistant to access.	More setup. Configure instructions, data sources, and tools for the agent.	Minimal. Select data sources for Assistant to access, but the entire workbook is visible.
Customization	Limited to the `:embed` and `:theme` URL parameters.	Full set of workbook embed URL parameters, plus a configurable greeting, instructions, and tools for the agent.	Full set of workbook embed URL parameters.
Data source scope	Admin-selected default sources, or any source the user has access to.	Only the data sources you configure for the agent.	Admin-selected default sources, or any source the user has access to.
Standalone experience	Yes.	Yes.	No. Requires embedding the full workbook.
Permissions	Requires the Use Assistant permission.	No additional permission required, only access to the embedded content.	Requires the Use Assistant permission.
JWT signing	Sign a JWT for the Assistant path.	Sign a JWT for the element path.	Sign a JWT for the workbook.
Support status	Deprecated. Ends March 16, 2027.	Available now.	Available now.

No matter what option you choose to embed, you can maintain observability into usage if you configure the AI usage dashboard.

Requirements

Complete all steps in Create an embed API with JSON Web Tokens to prepare a JWT-signed secure URL.
Set the account type for your embed users to an account type that includes the Use Assistant permission.
Ensure that your embed user teams have permission to access the data sources that you intend for them to be using when they ask questions using Assistant.

Customize the display of Sigma Assistant in your application

The embed URL signed with a JWT token has the following structure:

https://app.sigmacomputing.com/{org-slug}/ask?:jwt=<jwt>.

In the URL, ask is the path for Assistant.

To customize the appearance of Assistant, you can add two optional URL parameters:

URL parameter	Effect
`&:embed=true`	When set to true, this parameter removes Sigma branding from the Assistant interface. When you apply this setting, the Sigma logo is removed and the step and answer text do not make any references to Sigma.
`&:theme={theme-name}`	Theme applies a default workbook theme (Light, Dark, or Surface) or any custom theme defined for your organization. The value must be the name of the theme and is case-sensitive.