Manage API Keys

Overview

An API Key is an authentication token that allows you to make programmatic API calls to deployed models in Bridge. You use it in the Authorization header when sending requests to a model endpoint — for example, in curl commands or application code.

Prerequisites

• Tenant User access — You must log in as a Tenant User to generate API keys.
• Deployed model — A model must be deployed by a Tenant Admin and accessible in AI Studio. See Deploy Hugging Face Model, Deploy NIM Model, or Deploy Azure ML Model for details.

Generating 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 Model Serving.
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.

Using an API Key

Once generated, use the API Key as a Bearer token in the Authorization header of your API requests.

The Playground displays the exact curl command for your deployed model, with the $API_KEY placeholder ready to substitute:

Example curl request

curl -X POST "https://models.example.com/v1/chat/completions" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "model": "Qwen/Qwen2.5-1.5B-Instruct",
        "messages": [
            {
                "role": "user",
                "content": "<your message here>"
            }
        ],
        "top_k": 1,
        "top_p": 0.2,
        "temperature": 0.1,
        "max_tokens": 1000
    }'

Replace $API_KEY with your actual API Key value and update the model name and endpoint URL to match your deployment.

Find your endpoint URL

The endpoint URL is shown on the Playground page next to the curl command. Copy it directly from there to ensure accuracy.

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.

Next Steps

• Access Model Playground — Test deployed AI models interactively by sending prompts and inspecting responses in real time.