> Documentation index: [/llms.txt](/llms.txt). Every page as one file: [/llms-full.txt](/llms-full.txt).

# Create workspace API keys

Create workspace API keys [#create-workspace-api-keys]

A workspace API key lets a script or another system call Alomana in this workspace, with your access.

You need **Manage Workspace Settings** to open the page and **Create API keys**, which **Editor** and **Admin** have by default. Your plan must include API keys; otherwise **Create API Key** is greyed out with **Available on paid plans — upgrade**. Open **Settings** > **API Keys** under **Workspace · "*name*"**.

<img alt="The API Keys page with one active key, Weekly sales export, with the Agents, Files and Flow scopes" src="__img0" />

What a key can do [#what-a-key-can-do]

* A key acts as you, with your role in this workspace, and never has more rights than you.
* It works only in the workspace it was created in.
* It stops working when it is deleted or expires, when your account is disabled, or when you leave the workspace.
* The page lists only your own keys in this workspace; every member manages their own.

Create a key [#create-a-key]

1. Select **Create API Key**.

2. Enter a **Name** that says what the key is for, check the **Scopes** it needs and, optionally, turn on **Set Expiration Date** and pick a date.

   <img alt="The Create API Key dialog with the name Weekly sales export and the Agents, Files and Flow scopes checked" src="__img1" />

3. Select **Create API Key**.

4. Copy the key in **API Key Created** with **Copy & Close**. It is shown only this once.

| Scope                       | Lets the key use                                                  |
| --------------------------- | ----------------------------------------------------------------- |
| **Agents**                  | The Alomana API: agents, chats, connectors and workspace settings |
| **Files**                   | The Library's files and folders                                   |
| **Flow**                    | Flows                                                             |
| **Lab**                     | Lab evaluations; works only together with **Agents**              |
| **Lens**, **Jade**, **Vox** | The service agents of the same name                               |

New keys have **Agents**, **Files** and **Flow** checked. Without an expiration date a key never expires.

Regenerate, revoke or delete a key [#regenerate-revoke-or-delete-a-key]

Open the &#x2A;*⋮** menu at the end of the key's row.

| Action         | What it does                                                                                                                                               |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Regenerate** | Issues a new key value and shows it once; the old value stops working immediately. You can set a new expiration date.                                      |
| **Revoke**     | Stops the key from working. Its status becomes **Inactive**.                                                                                               |
| **Delete**     | Removes the key. Requests with it stop working; its past usage stays in the usage records. Needs **Delete API keys**, which only **Admin** has by default. |

| Status       | Meaning                                                                                        |
| ------------ | ---------------------------------------------------------------------------------------------- |
| **Active**   | The key works. A key past the date under **Expires** stops working but still shows **Active**. |
| **Inactive** | It was revoked.                                                                                |

To send a key with your requests, and for the full list of what a key can call, see [Authentication and API keys](/docs/api/api-basics/authentication) in the API documentation.