Embed Sigma Assistant

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.

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.

Using both of these parameters, you can seamlessly integrate the Assistant experience into your own application or website. For example, you can apply a custom theme so that Assistant adopts the colors of your portal, and set embed=true to remove Sigma branding from the experience.