Generate an API key

API keys in Toucan AI give you secure, programmatic access to embed analytics and manage data access in your product.

Objective

In this tutorial, you will learn how to generate an API key in Toucan AI. This key is required for integrating visualizations and embedding dashboards into your own software or website, as well as for generating tokens to control access to your data.

Prerequisites

• A Toucan AI account.

• Access to your profile settings.

Steps

1. Access Your Profile Settings

• In the bottom-left corner of the Toucan AI interface, click on the two letters representing your user profile. This is located above the Logout button.

• From the menu, scroll down to the Security section

2. Navigate to the API Keys Section

• On the Security section, locate the API Keys section. This is where you will create and manage your API keys.

3. Create a New API Key

• In the API Keys section, click on the Create API Key button.

• A new API key will be displayed on the screen. This key is required to securely interact with the Toucan AI API and generate tokens.

4. Store the API Key Securely

• Store the API key securely: It is essential that you store this key in a password manager or other secure storage system, as it is used to authenticate API requests.

• You will use this API key to generate tokens that can be used for embedding dashboards and controlling access to your visualizations.

5. API Key Usage

• The generated API key will allow you to interact with Toucan AI's API, enabling features such as token generation for secure embedding and data filtering.

• Make sure to keep your API key safe, as it is sensitive information and should not be shared publicly.

Conclusion

Congratulations! You have successfully generated an API key in Toucan AI. This key will be essential for embedding your visualizations and managing access securely through tokens.

Suggested Next Steps: Generate a sandbox token!