Settings and API Keys

The Settings → API Keys page manages API access for teams, local CLI profiles, and env-backed credentials. Settings is organized as a side navigation with General, Members, API Keys, Account, and Integrations sections — see Teams and Members for team management.

onyx login

The browser login flow lets you choose a team and creates or selects the matching local profile.

Env-Backed Profiles

Use this path when you create or rotate a key in the app:

export ONYX_TEAM_API_KEY="onyx_..."
onyx profile set-api-key-env team ONYX_TEAM_API_KEY

The profile keeps team metadata locally but reads the secret from your environment.

Direct Environment Overrides

Use direct overrides for scripts or CI jobs:

export ONYX_API_KEY="onyx_..."
export ONYX_API_URL="https://app.onyxresearch.ai"
onyx status

Key Actions

Action	Effect
Create	Shows a one-time secret for the selected team.
Rotate	Invalidates the old secret and shows a new one-time secret.
Revoke	Stops the key from authenticating.

Store secrets in a password manager, shell secret store, or CI secret manager. Onyx only shows the secret once.

Teams and Members

Getting Started

Tutorials

Concepts

Platform

Settings and API Keys

Env-Backed Profiles

Direct Environment Overrides

Key Actions

​Recommended: CLI Login

​Env-Backed Profiles

​Direct Environment Overrides

​Key Actions

Recommended: CLI Login

Env-Backed Profiles

Direct Environment Overrides

Key Actions