> For the complete documentation index, see [llms.txt](https://docs.fusion.vectra.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fusion.vectra.ai/settings/user-management/index/add-api-key.md).

# Add API Key

## Getting Here <a href="#getting-here" id="getting-here"></a>

**Settings > User Management > API Keys > Add API Key button**

## Add New API Key Form <a href="#add-new-api-key-form" id="add-new-api-key-form"></a>

The **Add New API Key** form allows users to create and configure API keys for accessing system integrations and automation.

***

### Form Fields <a href="#form-fields" id="form-fields"></a>

1. **Application Name\***
   * **Description**: A required field to specify the name of the application or purpose for which the API key is being created.
   * **Required**: Yes
2. **Description**
   * **Description**: An optional field to provide additional context or notes about the API key’s usage.
   * **Required**: No
3. **Role\***
   * **Description**: Defines the access permissions for the API key.
   * **Options**:
     * `admin`: Provides full administrative privileges.
     * `readonly`: Grants read-only access.
   * **Control**: Dropdown menu to select the role.
   * **Required**: Yes

***

### Form Actions <a href="#form-actions" id="form-actions"></a>

1. **SAVE**
   * **Description**: Saves the API key configuration and creates the new key.
2. **CANCEL**
   * **Description**: Discards changes and closes the form without creating a new API key.

***

### Notes <a href="#notes" id="notes"></a>

* Fields marked with an asterisk (\*) are **mandatory**.
* Use descriptive and clear **Application Names** to identify the API key's purpose.
* Carefully select the **Role** to limit access as necessary:
  * Use `readonly` for minimal permissions.
  * Use `admin` only for full administrative access when required.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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.fusion.vectra.ai/settings/user-management/index/add-api-key.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.