End-to-end Quick Start with Toucan AI

Toucan AI is designed to help you move from raw data to embedded analytics in minutes—combining AI-powered automation with full manual control.

Objective

In this tutorial, you will learn how to get started with Toucan AI and go through the steps to create and embed a dashboard into your application. By following this guide, you'll be able to:

1. Add a database.

2. Analyze your database with AI.

3. Complete metadata information.

4. Create a dashboard with AI.

5. Embed the dashboard into your application.

For each step, you will find more information in the dedicated practical guide (How-To sections).

---

Step 1: Add a Database

First, you need to connect a database to Toucan AI.

1. From the Home Page, go to the Database tab and click Add Database.

2. Select the appropriate connector (e.g., PostgreSQL).

3. Fill in the required fields (e.g., Host, Username, Password, Database name).

4. Click Test Connection to ensure the connection works, then click Connect.

Example: Connect to your HR database containing employee data, including a location column with values like Tokyo, Paris, etc.

How-To: Add a database

---

Step 2: Analyze Your Database with AI

Once the database is connected, you can use AI to analyze its structure and automatically enrich the data.

1. Click on the database you've just connected.

2. In the database view, click Analyze to let the AI scan and enrich your data automatically.

3. Review the auto-generated descriptions for tables and columns.

Example: The AI will recognize your location column and help categorize it, making it ready for visualizations.

How-To: Analyze your database with AI

---

Step 3: Complete Metadata Information

Refine the data descriptions to improve the AI's ability to generate accurate dashboards.

1. In the Metadata section, verify and update descriptions for any tables and columns that need refinement.

2. Ensure important columns are accurately described to provide better context for your dashboard and AI prompt.

---

Step 4: Create a Dashboard with AI

Next, let's create a dashboard using AI.

1. Go to the Library menu and locate the central block where you can type a prompt.

2. In this conversational interface, type a prompt to create your dashboard

   1. For example : "Create a dashboard to track employee contracts and locations".

3. The AI will automatically generate a dashboard with relevant charts based on your prompt.

4. Of course you can also:

   1. Prompt new charts

   2. Modify manually these charts

   3. Add filters and modify the layout

Example: The AI creates a dashboard that tracks employee contract types and locations (e.g., Tokyo, Paris).

How-To: Create a dashboard with AI

---

Step 5: Embed the Dashboard

Once you are satisfied with your dashboard, the next step is to integrate it in your SaaS or Website.

To embed the dashboard into your application, you will need a valid API key and token. Here's how to get them:

1. Generate Your API Key

To interact with the API and embed the dashboard, you need an API key.

1. Go to your Profile at the bottom-left corner of the screen and click on the two letters representing your user profile.

2. Click Security to open the security settings page.

3. Under the API Keys section, click Create API Key.

4. Copy the generated API key and store it securely (in a password manager, for example).

How-To: Generate an API Key

2. Generate a Token

Now that you have the API key, you need to generate a token that contains the necessary user attributes.

1. Go to Settings > Embed in the menu.

2. In the Token Generation Sandbox section, paste your API key into the field.

3. Click Generate Token.

4. Copy the generated token. This token will be used to authenticate the dashboard embedding.

5. This is a token to try the embedding. In real usage or production in a SaaS, you will call an API endpoint to make it work.

How-To: Generate a sandbox token

3. Embed the Dashboard with the Token

1. Go back to the Dashboard view in Toucan AI.

2. Click on the three dots in the top-right corner and select Embed.

3. Copy the embed code provided in the window.

4. Open your code editor (e.g., CodePen or your application’s code).

5. Paste the embed code into the HTML section of your editor.

6. Replace the placeholder Auth-Token with the valid token you generated earlier.

Example: Embed the HR dashboard in your SaaS application. Users in your SaaS will be able to use the dashboard, in full white label, and even create their own charts with AI.

How-To: Embed a dashboard

Once the token has been copied into the web component, this is what it looks like (here on codepen.io, for example).

---

Conclusion

Congratulations! You've successfully completed the Getting Started in Toucan AI. You have:

1. Connected your database.

2. Analyzed and enriched your data with AI.

3. Created a dashboard using AI.

4. Embedded your dashboard into your application with a secure token.

Your dashboard is now live and ready for use in your software or website. Enjoy your data-driven insights powered by Toucan AI!