Skip to main content

API and developer settings

Create, view and revoke API keys in the console, and find the developer documentation from inside the app.

On this page

Settings, API & Developer is where you manage API keys. Opening it needs the keys:read member scope.

Create a key

  1. Choose Create API key. A dialog of the same name opens.
  2. Give the key a Name that says where it runs.
  3. Choose an Expiration: the workspace default, 7 days, 30 days or 90 days. Your workspace policy may shorten it, and no key lives longer than 365 days by default.
  4. Choose its Access scopes. Three are selected for you: LLM gateway (llm:access), Agent API & chat (llm:chat) and cli:knowledge:read. You can add Embeddings (llm:embeddings) and the other optional scopes the dialog lists. A scope you do not hold in your organization is listed but cannot be selected; llm:* scopes are always available.
  5. If your sign-in is older than five minutes, confirm your password.
  6. Choose Create key, then copy the key from the one-time Save this key panel and choose I’ve saved it. It cannot be shown again.

Scopes the dialog does not offer, such as llm:batch, can be requested through the API keys endpoint, under the same rule. See Authentication and API keys for what each scope allows.

You receive a security notification by email whenever a key is created on your account.

View and revoke keys

Your keys lists each key with its name, prefix (bl_live_ and four characters) and expiry, and marks expired and revoked keys. Revoke a key and it stops working immediately.

Limits

You can have up to 10 active keys and create up to 5 per hour. See Authentication and API keys for scopes and the full key lifecycle.

The page also shows a Quick start with the base URL, the model and a first call, and links to the Nebula API and Platform API documentation.

Search documentation

Type to search guides, the API reference, the CLI and the console guide.

    Enter open↑ ↓ moveEsc close