Licensed to be used in conjunction with basebox, only.
// admin
API Keys
Brief description
API keys allow applications to access the basebox REST API programmatically. As an administrator, you create and manage your organization's keys here.
What are API keys used for
With an API key, your own applications, scripts, or integrations can use your organization's language model securely and with authentication – without a user having to log in manually. This lets you integrate basebox into your own tools or automated workflows.
Where to find API keys
Open Administration → API Keys in the sidebar. The page shows:
- a brief explanation of managing keys for REST API access
- the "Create API key" button
- a table of existing keys with the columns Name, Created (date/time), and Actions (delete via the trash can icon)
- a count of the keys found
Step by step
Creating an API key:
- Open Administration → API Keys
- Click "Create API key"
- In the dialog, give it a meaningful name (e.g., the purpose or the connecting application)
- Click "Create API key" (or "Cancel" to discard the process)
Deleting an API key:
- Find the key in the table
- Click the trash can icon in the Actions column
The key becomes invalid immediately; applications using it lose access.
Notes
Keep keys safe
An API key grants access to your organization's API. Treat it like a password: don't share it, and store it in a secure place. The key is usually shown only once, at creation – copy it immediately.
Deletion cannot be undone
A deleted API key becomes invalid immediately. All applications and integrations using this key will stop working. Only delete a key if you're sure it's no longer needed.
Administrators only
API keys can only be created and managed by administrators.
Frequently asked questions
What do I need an API key for? To connect your own applications or integrations to the basebox REST API securely and with authentication, and to use your organization's language model through it.
Who is allowed to create API keys? Only administrators of your organization.
What happens if I delete a key? It becomes invalid immediately. Applications using it lose access.
Can I restore a key later? No. Once a key is deleted, a new one must be created if needed.