Skip to main content
The API Key tab is where you create the keys your application uses to authenticate with the runtime API.
API Keys tab in the Zelinqa NBQ Studio
The list shows each key masked (prefix + last 4 characters), its creation date, and whether it is Active or Revoked. You can generate multiple keys — for example one per environment — and revoke any of them instantly.
The API Key tab is locked until your NBQ instance has at least 10 active questions. Build your question bank first, then return here to generate a key.

Generating a key

1

Open the API Key tab

Click Configuration → API Key in the NBQ Studio navigation.
2

Click Generate a key

A new key is created immediately and displayed in full — this is the only time you will see it.
3

Copy the key now

Copy it and store it as a secret in your application (environment variable or secrets manager). Once you leave the page, the full key cannot be retrieved again.
The API key is shown only once. If you lose it, revoke it and generate a new one.

Key format

Every NBQ Engine key starts with nbq_live_:
nbq_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Key list

The key list shows each key masked (prefix + last 4 characters), its creation date, and its status (Active or Revoked). You can generate several keys per instance — for example, one per environment.

Revoking a key

Click Revoke next to any key. It stops working immediately. Generate a replacement key and update your application. For full security guidance, see API Key Safety.