Login
Updated on November 3, 2026

API Keys

Estimated reading: 4 minutes

The API Keys page allows users to create and manage Project API Keys for a project. These keys provide the credentials required for applications, integrations, and services to authenticate and securely connect to the Control Plane.

Properties

Field Description
Public Key Identifies the API key used in API requests.
Secret Key Provides the credential used for server-side authentication. This value is sensitive and must be kept confidential.
Environment Configuration Provides a preformatted configuration snippet for connecting an application to the project.
API Keys List Displays the Project API Keys created for the project and their associated details.
Note: Store Secret Keys securely. After a key is generated, access should be restricted to authorized users and systems to prevent unauthorized use.

Project API Key Components

Each Project API Key includes a Public Key and a Secret Key.

Public Key: Identifies the API key and is used in API requests as supported by the platform.
Secret Key: Provides the credential used for server-side authentication. Keep it confidential and do not expose it in client-side code or public repositories.

Environment Configuration

The API Keys page provides a preformatted .env configuration snippet containing the Public Key, Secret Key, and Control Plane base URL. This simplifies application configuration by providing the required values in one place.

Example:

CONTROLPLANE_SECRET_KEY=”sk-…”
CONTROLPLANE_PUBLIC_KEY=”pk-…”
CONTROLPLANE_BASE_URL=”https://test-rag.robility.ai”

Replace the placeholder values with the generated credentials and the appropriate project base URL.
Copy the snippet into your application’s environment configuration file for local development, backend services, or deployment environments. Ensure that the application is configured to load these values before making authenticated requests.

Note: The .env configuration display does not fully support environment-file syntax highlighting. The content is displayed using plain-text formatting.

Security Note: Store the Secret Key in environment variables or an approved secrets-management system. Do not commit it to source control or expose it in browser-based code.

API Keys List

The API Keys List displays the Project API Keys created for the project.

Columns

Column Description
Created Displays the date and time when the API key was generated.
Note Displays the label assigned to the key to help identify its purpose.
Public Key Displays the public identifier associated with the API key.
Secret Key Displays the secret credential in a restricted view.
Note: If no API keys have been created, the table displays None.

Role-Based Permissions

The available API key operations depend on the user's project role.

Role Permissions
Project Owner Can create, read, update, and delete Project API Keys.
Administrator Can create, read, update, and delete Project API Keys.
Member Can read and view existing Project API Keys but cannot create, update, or delete them.

Create an API Key

Users with the Project Owner or Administrator role can create a Project API Key.

1. Click Create New API Key.
2. Enter a Note to identify the key, such as Production or Testing.
3. Click Generate.

After generation, a dialog displays the following details:

a. Secret Key 
b. Public Key
c. Environment Configuration snippet

Click the corresponding Copy option to copy an individual value or the configuration snippet.

Important: The Secret Key is displayed only once and cannot be retrieved after the dialog is closed. Copy and store it securely before closing the dialog.

If the Secret Key is lost, generate a replacement API key and update the applications that use the previous credentials.

Manage API Key Security

Follow these practices to protect API credentials:

1. Create separate API keys for different applications or environments when appropriate.
2. Store Secret Keys securely using environment variables or an approved secrets-management system.
3. Do not share Secret Keys or include them in publicly accessible code.
4. Review existing keys periodically and remove keys that are no longer required.
5. If a key is compromised, generate a replacement and update dependent applications as soon as possible.

Delete an API Key

Users with the Project Owner or Administrator role can delete a Project API Key when it is no longer required.

1. Locate the key in the API Keys List.
2. Click Delete for the corresponding API key.
3. Confirm the deletion when prompted.

Before deleting a key, identify any applications or services that depend on it. If necessary, generate a replacement key and update those applications before deleting the existing key.

Note: Deleting an API key may prevent applications using that key from authenticating with the project. Ensure that dependent applications are updated before proceeding.

Project Settings - Previous General Next - Project Settings LLM Connections
Share this Doc

API Keys

Or copy link

CONTENTS

Powered By Sutherland

Robility Chatbot
Robility Assistant
Online