Getting Started
Create an API key
Create a SuperPenguin API key and keep it server-side.
- Sign in to the dashboard.
- Open API Keys (also linked as API Keys).
- Click Create API Key.
- Copy the key immediately. It starts with
sp_orsp-and is shown once.
Use the key safely
Store the key in a server environment variable such as SP_API_KEY. Never expose it in client-side JavaScript, mobile apps, or public repositories.
Python:
import superpenguin as sp
sp.init(api_key="sp_...") # or rely on SP_API_KEYTypeScript:
import { init } from "@superpenguin/js";
init({ apiKey: process.env.SP_API_KEY });If SP_API_KEY is set, both SDKs can initialize automatically on first use.
Optional overrides
| Variable | Purpose |
|---|---|
SP_API_KEY | SuperPenguin ingest key |
SP_BASE_URL | Override the default API base URL (advanced / staging) |
Next: Add attribution metadata.