> For the complete documentation index, see [llms.txt](https://docs.buildings.ability.abb/collection/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.buildings.ability.abb/collection/english-v14/documentation/einstellungen/api-schlussel.md).

# API keys

## Create API key

<div data-full-width="true"><figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/Iz7Cut2kXAHWR0hjxXxC/API-Schl%C3%BCssel.png" alt=""><figcaption></figcaption></figure></div>

1. **Navigate to the settings \[A]**\
   Click the gear icon in the left sidebar to *settings* open it.\
   ▷ The menu *settings* is displayed.
2. **Manage API keys \[B]**\
   Click the tab in the top menu bar *API keys*.\
   ▷ The page for managing API keys opens.
3. **Create new API key \[C]**\
   Click the button **+ API key** in the upper right corner.\
   ▷ A form for entering the API key details is displayed.
4. **Enter API key details**\
   Enter the required information:

   ***Name***: Enter a unique name for the API key.

   ***Expiration date***: Select an expiration date if the key is to be time-limited.

   ◈ An expired API key can no longer be used and must be renewed to maintain the connection to the API.
5. **Create API key**\
   Click on **Create**, to create the new API key.\
   ▷ The new API key is displayed in the list of API keys.

{% hint style="danger" %}
API keys should only be made available to trusted persons in order to protect access to your *Eliona*-data.
{% endhint %}

## API key information

On the *API keys*-list page, you can view the following information for each API key:

**API key name**\
The API key name is displayed in the list to allow clear identification.

**Expiration date**\
The expiration date of the API key is displayed prominently.

◈ Once an API key has expired, it can no longer be used, and access to the API is blocked.

**Expired status**\
If an API key has expired, this is indicated by a warning message on the right side next to the key. <img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/p5dGyZTufsGFkZKk0mqT/image.png" alt="" data-size="line">

{% hint style="info" %}
An expired API key must be renewed to restore the connection to the API.
{% endhint %}

**Copy API key**\
For each key there is a button **Copy key** available that can be used to copy the key to the clipboard. <img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/tX0Kjfh1jPiG5Dqh4lSf/image.png" alt="" data-size="line">\
▷ You can use the copied key to authenticate API requests.

**Delete API key**\
Using the button <img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/OLHQ0t6dCgV6CCFGw81t/image.png" alt="" data-size="line"> an API key that is no longer needed can be removed.

**Show more information**\
Click on **More information** <img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/bukGjbmBrAJDJxV6p2wG/image.png" alt="" data-size="line">, to display additional details about the API key.<br>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.buildings.ability.abb/collection/english-v14/documentation/einstellungen/api-schlussel.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
