Embed Ask Sigma (Beta)

🚩
This documentation describes a public beta feature and is under construction. This documentation should not be considered part of our published documentation until this notice, and the corresponding Beta flag on the feature in the Sigma service, are removed. As with any beta feature, the feature discussed below is subject to quick, iterative changes. The latest experience in the Sigma service might differ from the contents of this document.
Beta features are subject to the Beta features disclaimer.

You can embed the Ask Sigma interface, which offers your users the ability to ask natural language queries of your data, into your own application or website. For more about Ask Sigma, see Ask natural language queries with Ask Sigma.

Requirements

Complete all steps in Create an embed API with JSON Web Tokens (Beta) to prepare a JWT-signed secure URL.
Set the account type for your embed users to an account type that includes the Use Ask Sigma 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 Ask Sigma.

Limitations

Embedding Ask Sigma is only supported when using JWT tokens to secure the embed URL. See Create an embed API with JSON Web Tokens (Beta).

Customize the display of Ask Sigma in your application

The embed URL signed with a JWT token will have this structure: https://app.sigmacomputing.com/{org-slug}/ask?:jwt=<jwt>.

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

URL parameter	Effect
`&:embed=true`	When set to true, this parameter removes Sigma branding from the Ask Sigma 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 Ask Sigma experience into your own application or website. For example, you can apply a custom theme so that Ask Sigma adopts the colors of your portal, and set embed=true to remove Sigma branding from the experience.