Skip to main content

​
Overview

TextQL can be embedded directly into your own applications, allowing your users to interact with Ana without leaving your platform. This is done using API Keys for authentication.

​
Creating an API Key

​
Step 1: Navigate to API Keys

From the left sidebar, click on Settings. In the Configuration tab, locate the API section and click API Keys.
API section in Settings with API Keys button highlighted

Click API Keys under the API section in Settings

​
Step 2: Create a New API Key

Click Create New API Key and give your API key a name. This API key will have the same permissions as the user creating it.
API Keys Management modal showing key creation

Create a new API key with a descriptive name

Copy your API key immediately after creation. For security reasons, you won’t be able to see the full key again.

​
Testing Your Embed

Once you have your API key, you can test the embed functionality:
  1. Construct the embed URL by appending your API key to the base URL: 
    https://app.textql.com/embed?authKey=YOUR_API_KEY
  2. Replace YOUR_API_KEY with the API key you just created.
  3. Open this URL in a new browser tab or incognito window.
  4. If successful, you should see a new chat with Ana. This confirms your API key is working correctly.

​
Embedding in Your Application

After testing, you can embed TextQL in your application using an iframe: 
<iframe
  src="https://app.textql.com/embed?authKey=YOUR_API_KEY"
  width="100%"
  height="600px"
  frameBorder="0"
  allow="clipboard-write"
></iframe>
The authenticated user will have the same data access and permissions as the user who created the API key.

​
Embedding in Tableau

You can embed TextQL directly into Tableau dashboards using the Web Page object.

​
Step 1: Create a New Workbook

In Tableau, click New and select Workbook to create a new workbook.
Tableau home with New Workbook option highlighted

Create a new workbook in Tableau

​
Step 2: Create a Dashboard

Click New Dashboard at the bottom of the screen to add a dashboard to your workbook.
Tableau workbook showing New Dashboard button

Create a new dashboard

​
Step 3: Add a Web Page Object

From the Objects panel on the left, drag the Web Page object onto your dashboard.
Objects panel with Web Page option highlighted

Select Web Page from the Objects panel

​
Step 4: Enter the Embed URL

In the Edit URL dialog, paste your embed URL with your API key: 
https://app.textql.com/embed?authKey=YOUR_API_KEY
Edit URL dialog in Tableau

Paste your embed URL with the API key

Click OK to embed TextQL into your dashboard.

​
Step 5: Chat with Ana in Tableau

Once embedded, you can interact with Ana directly within your Tableau dashboard. Ask questions, analyze data, and get insights without leaving Tableau.
Ana chat interface embedded in Tableau dashboard

TextQL embedded in Tableau dashboard

​
Security Considerations

  • API keys inherit all permissions from the user who creates them
  • Store API keys securely and never expose them in client-side code
  • Rotate API keys regularly for enhanced security
  • Delete unused API keys from the API Keys Management panel