> For the complete documentation index, see [llms.txt](https://docs.voltmasters.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.voltmasters.io/voltmasters-platform/10.-project-settings/10.9-api-keys.md).

# API keys

Under **Settings → Project Settings → API Keys**, you can create and manage API keys that allow external software to communicate with the Voltmasters API for this project.

### What is an API key?

An API key is a secure access token that lets your own software, scripts or third-party tools, such as home automation systems, reporting tools or custom integrations, interact with the Voltmasters API for this specific project. Each key is scoped to this project and grants the permissions needed to read or write data via the API.

### Creating an API key

1. Navigate to **Settings → Project Settings → API Keys**.
2. Click **Create API key**.
3. Enter a recognisable name for the key, for example `home-automation` or `reporting-script`.
4. The secret portion of the key is displayed **only once**, at the moment of creation. Copy it immediately and store it in a secure location. It cannot be retrieved again.

{% hint style="warning" %}
If you lose the secret, you will need to create a new API key and update any integrations that use the old one.
{% endhint %}

### API documentation

Click the **API Documentation** button to open the full reference for all available API endpoints, parameters and usage examples. This documentation is hosted on the Voltmasters documentation portal.


---

# 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.voltmasters.io/voltmasters-platform/10.-project-settings/10.9-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.