Platform API Keys

API Keys authenticate your applications and services when communicating with the InteractiveAI platform. The platform uses two distinct key types for different purposes: Project API Keys for SDK operations and Router API Keys for LLM access.

Key Types

Project API Keys authenticate SDK requests for tracing, prompt management, and evaluation operations. When you create a project API key, the platform generates two credentials:

Credential

Format

Purpose

Public Key

pk-...

Identifies your project in API requests

Secret Key

sk-...

Authenticates requests

Both credentials are required to initialize the InteractiveAI SDK. Set them as environment variables:

INTERACTIVEAI_PUBLIC_KEY="pk-..."
INTERACTIVEAI_SECRET_KEY="sk-..."
INTERACTIVEAI_HOST="https://app.interactive.ai"

Then initialize the client:

from interactiveai import Interactive

interactiveai = Interactive()

Router API Keys allow your application to route LLM requests through InteractiveAI's unified API. Unlike Project API Keys, Router API Keys generate a single credential called the Authentication Key (sk-...).

The Router authenticates requests via Bearer tokens in the Authorization header, enabling direct usage with curl or compatibility with the OpenAI SDK:

from interactiveai.openai import OpenAI
import os

client = OpenAI(
    base_url="https://app.interactive.ai/api/v1",
    api_key=os.environ["LLMROUTER_API_KEY"]
)

Or when calling the Router API directly:

curl https://app.interactive.ai/api/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $LLMROUTER_API_KEY" \
  -d '{
    "model": "openai/gpt-4o",
    "messages": [
      {"role": "user", "content": "Hello, world!"}
    ]
  }'

Creating API Keys

Creating a Project API Key

Navigate to Settings → API Keys
Locate yourself onto the Project API Keys tab
Click + Add New
Select Project API Key
Copy both the Public Key and Secret Key immediately

Creating a Router API Key

Navigate to Settings → API Keys
Locate yourself onto the Router API Keys tab
Click + Add New
Select Router API Key
Assign a descriptive name for the key
Copy the Authentication Key immediately

You cannot retrieve these keys after creation. Store them securely before closing the dialog.

Security Best Practices

Store keys in environment variables. Never hardcode API keys in your application code. Use environment variables and exclude them from version control by adding your .env file to .gitignore.
Never expose keys in client-side code. API keys should only be used in server-side applications. Exposing them in frontend code, public repositories, or browser-accessible JavaScript compromises your account security.
Use descriptive names for Router keys. Naming keys by application or environment (e.g., "production-backend", "staging-api") makes it easier to identify and rotate specific keys without affecting other services.
Rotate keys periodically. Generate new keys and update your applications before revoking old ones to avoid service interruption.

Compromised Keys

InteractiveAI participates in GitHub's secret scanning program and employs additional detection methods for exposed credentials. If a compromise is detected, you will receive an email notification.

Upon notification, or if you suspect exposure:

Navigate to Settings → API Keys
Revoke the compromised key immediately
Generate a replacement key
Update your application's environment variables

PreviousScore Configs NextCustom LLMs

Last updated 3 months ago

Was this helpful?