Skip to navigation
User Guide: SDKSetup

API Key Management

View as Markdown

Use an API key to authenticate the Kumo Predict SDK with your Kumo Studio.

Create an API Key

Open API Keys in your Kumo Studio, or navigate to https://<your-kumo-platform-dns>/api-keys.

Select Create API key, give the key a descriptive name, and copy the value when it is displayed. For security, Kumo shows the full key only when you create it.

Store API keys in a secret manager or other secure location. Do not commit them to source control or share them in notebooks.

If you cannot access the page or create a key, contact your Kumo Studio administrator.

The public API URL of your Kumo Studio is https://<your-kumo-platform-dns>/api.

Configure the SDK

Set the SDK endpoint to your Kumo Studio DNS name followed by /api.

export KUMO_API_ENDPOINT="https://<your-kumo-platform-dns>/api"
export KUMO_API_KEY="<api-key>"

Initialize the SDK with those values:

import os
import kumoai
kumoai.init(
    url=os.environ["KUMO_API_ENDPOINT"],
    api_key=os.environ["KUMO_API_KEY"],
)

Rotate or Revoke a Key

To rotate a key, create a replacement, update every SDK environment that uses the old key, and then delete the old key from API Keys. Deleting a key immediately prevents it from authenticating to the Kumo Studio.