Manage API Keys

Overview

An API Key is an authentication token that allows you to make programmatic API calls to your JupyterHub notebook server — for example, when connecting from scripts, extensions, or external tools. This page covers how to create, use, and revoke API keys.

Prerequisites

• Tenant User access — You must log in as a Tenant User to generate API keys.
• JupyterHub notebook — A JupyterHub notebook must be provisioned and accessible in AI Studio.

Create an API Key

Step 1: Open AI Studio

1. Log in to Bridge as a tenant user.
2. In the left sidebar, click AI Studio. This opens AI Studio in a new tab.

Step 2: Navigate to Settings

1. In the AI Studio tab, click Settings in the sidebar.

Step 3: Add an API Key

1. Click Add API Key.
2. Enter a Name for the key and set Type to JupyterLab.
3. Click Create Key to generate the key.
4. Copy the key immediately. Store it securely.

Copy your API Key now

The API Key is only displayed once at the time of creation. If you lose it, you will need to generate a new one.

Use an API Key

Once the API key is created, you can use it to integrate with external tools like VS Code to access the JupyterHub notebook server.

Revoke an API Key

1. In AI Studio, go to Settings to view all API keys.
2. Click the delete (bin) icon next to the key you want to revoke.
3. Click Revoke API Key to confirm.

The key is immediately invalidated and can no longer be used.