Skip to content

How to generate API Key on Kalp Bot?

Kalp Studio offers a suite of tools for managing knowledge bases, chatbots, and more. To extend its functionality and integrate it with other applications or services, API (Application Programming Interface) keys are essential. API keys act as unique identifiers and secret tokens for authentication, allowing your external applications to securely communicate with Kalp Studio's services.

This guide will walk you through the simple process of generating a new API key within your Kalp Studio dashboard.

Prerequisites:

  • An active Kalp Studio account.

  • Access to your Kalp Studio dashboard.

Step-by-Step: Generating Your API Key

Follow these steps to create and retrieve your API key:

Step 1: Navigate to the API Keys Section

  1. Log in to your Kalp Studio account.

  2. On the main dashboard, locate the left-hand navigation menu.

  3. Click on the "API Keys" option, typically indicated by a key icon.

Step 2: Initiate API Key Creation

  1. If you haven't created any API keys before, you'll see a message like "No API keys Found!"

  2. Click on the prominent "+ Create API Key" button.

Step 3: Provide API Key Details

  1. You will be redirected to the "Create API Key" page.

  2. You'll need to fill in the following details:

    • Enter Key Name: Provide a descriptive name for your API key. This helps you identify its purpose later (e.g., "My Web App Integration," "Data Sync Script").

    • Description: Add an optional, more detailed description for the key's use case.

Step 4: Generate and Copy the Key

  1. Once you've filled in the "Key Name" and "Description" (optional), click the "Create" button.

  1. A modal window will pop up with the message: "API Key has been successfully generated."

  2. Your newly generated API key will be displayed in this modal. This is the only time the full API key will be visible.

  3. Click the copy icon next to the API key to copy it to your clipboard.

Important: Immediately paste this key into a secure location (like a password manager or a secure note). Once you close this modal, you will not be able to retrieve the full key again for security reasons.

Step 5: View and Manage Your API Keys

  1. After copying the key, you can click the "View Details" button in the modal, or simply close the modal.

  2. You will be taken to the "Keys' Details" page, which lists all your API keys.

  3. Here, you'll see your newly created key listed with its:

    • Name

    • A partial view of the API Key (for identification)

    • Date Created

    • Status (which can often be toggled to activate or deactivate the key)

Conclusion

Generating an API key in Kalp Studio is a straightforward process designed with security in mind. By following these simple steps, you can quickly obtain the necessary credentials to integrate Kalp Studio with your other systems, automate workflows, and unlock the full potential of the platform. Remember to always handle your API keys with care to maintain the security of your account and data.