# API keys

{% hint style="info" %}
API keys allow to call of the Scaleflex DAM file management API and are suited for backend or headless applications where no user context is needed and where the key is not exposed to the browser
{% endhint %}

### Create new API keys <a href="#create-new-api-keys" id="create-new-api-keys"></a>

Authentication against the Scaleflex API is done with an API Secret Key, available under [Settings > Project > Access (page) > API keys (tab)](https://hub.scaleflex.com/settings/project/access/api-keys).

New API keys can be created with the *+Add key* button. On click, the user will be requested to:

* Enter the API key description so it can be easily identified
* Select the permissions to be attached with the API key (multi-selection from the permissions list) -- these define what the user will be able to do with the assets

#### **Permissions**

| API Permission             | Description                          |
| -------------------------- | ------------------------------------ |
| `OBJECTS_LIST`             | List assets                          |
| `OBJECTS_FETCH`            | Fetch assets                         |
| `FILE_UPLOAD`              | Upload file                          |
| `FILE_META_CREATE`         | Create file metadata                 |
| `FILE_META_CHANGE`         | Update file metadata                 |
| `FILE_RENAME`              | Rename file                          |
| `FILE_MOVE`                | Move file                            |
| `FILE_DELETE`              | Delete file                          |
| `FILE_SET_VISIBILITY`      | Set file visibility                  |
| `FILE_LABEL_CHANGE`        | Update file labels                   |
| `FILE_IMAGE_EDITOR`        | Edit file                            |
| `DIR_CREATE`               | Create directory                     |
| `DIR_RENAME`               | Rename directory                     |
| `DIR_META_CHANGE`          | Create and update directory metadata |
| `DIR_MOVE`                 | Move directory                       |
| `DIR_DELETE`               | Delete directory                     |
| `DIR_SET_VISIBILITY`       | Set dir visibility                   |
| `CONFIG_CHANGE`            | Change container configuration       |
| `CONFIG_LIST`              | List container configuration         |
| `FILE_PRODUCT_CHANGE`      | Change product information           |
| `FILE_PROCESS_AUTOTAGGING` | Perform autotagging                  |
| `COLLECTIONS_LIST`         | List collections                     |
| `COLLECTIONS_MANAGE`       | Manage collections                   |
| `LABELS_LIST`              | View labels                          |
| `LABEL_MANAGE`             | Manage labels                        |
| `OBJECTS_SHARE_MANAGE`     | Manage sharebox                      |
| `OBJECTS_AIRBOX_MANAGE`    | Manage airbox                        |
| `OBJECTS_APPROVAL_MANAGE`  | Manage approval                      |
| `OBJECTS_APPROVAL_VOTE`    | Approve/Reject assets                |
| `ACCESS_READ`              | View accesses                        |
| `ACCESS_MANAGE`            | Manage accesses                      |

### Manage Existing API Keys <a href="#manage-existing-api-keys" id="manage-existing-api-keys"></a>

Existing API keys can be managed individually or in bulk for status (Active <> Deactivate).&#x20;

| Setting     | Description                                                                                                                                                       |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Description | To identify the API keys                                                                                                                                          |
| Secret key  | The API key value. To be kept secret                                                                                                                              |
| Created at  | The API key creation date                                                                                                                                         |
| Active      | <p>The API key status that can be toggled from activated to deactivated using the ... options</p><p>Note:  If used, deactivated API keys will return an error</p> |
| Copy        | Copy the secret key in the clipboard for easy integration                                                                                                         |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.scaleflex.com/vxp-visual-experience-platform/settings/project/access/api-keys.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.