> ## Documentation Index
> Fetch the complete documentation index at: https://docs.minerva.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API access

> Create and manage the API keys you use with the Minerva API, SDK and SFTP

API keys let your own code and tools use Minerva. To manage them, select your name at the bottom of the sidebar, then **Settings → API**, or go straight to [app.minerva.io/settings/api](https://app.minerva.io/settings/api).

## Types of keys

| Tab | What it is |
| - | - |
| **Personal** | A key tied to your account in this organization. It is revoked when you leave the organization. |
| **Organization** | A key that belongs to the organization and can be used by any member. |
| **Legacy** | An older key, if your organization has one. It stays masked. You can revoke it, but you can't view it or create a new one. |

Use **Personal** or **Organization** for anything new. Under the default roles, both Members and Admins can create and manage keys.

## Create a key

**1. Open API settings**

In the organization the key is for, go to **Settings → API** and choose the **Personal** or **Organization** tab.

**2. Start a new key**

Select **Create API key**.

**3. Name the key**

Enter a **Name** that says what the key is for and set its **Expiration**, then select **Create API key**.

**4. Copy the key**

Copy the key when it's shown and store it somewhere secure, then select **Copy and close**.

> [!WARNING]
>
> The full key is shown once. You won't be able to see it again, so copy it before you close the dialog. If you lose it, create a new key.

## Use a key

| With | How |
| - | - |
| The API | Send the key in the `x-api-key` header. See the [API reference](https://docs.minerva.io/api-reference/introduction.md). |
| The Python SDK | Set the `MINERVA_API_KEY` environment variable. See the [SDK guide](https://docs.minerva.io/sdk/introduction.md). |
| SFTP | Use the key as your SFTP password. **Personal**, **Organization** and existing **Legacy** keys all work. See the [SFTP guide](https://docs.minerva.io/sftp/introduction.md). |

The Minerva Data MCP doesn't use an API key. You sign in with your Minerva account instead. See the [MCP guide](https://docs.minerva.io/minerva-data-mcp.md).

Creating a key doesn't grant access to every endpoint. What a key can do still depends on your organization's plan and the permissions that apply to the key.

## View, replace or revoke a key

* **View details** shows a key's name, when it was created, when it was last used and when it expires. The key itself stays masked.
* **Edit expiration** changes when the key expires. It doesn't change the key.
* **Revoke key** turns the key off. Anything using it stops working, though not always right away. Revoking can't be undone.

To replace a key safely, create the new one, update and test whatever uses it, then revoke the old one.

> [!WARNING]
>
> Never put a key in a document, a screenshot, a chat or a support message.

## See your API usage

API usage is on **Billing & Usage**, not on the API page. It shows **Requests**, **Matches**, **Input records** and **Resolvable records** by endpoint and over time.

These measure different things, and none of them is your bill.

## Limits and billing

Creating, naming and revoking keys don't use your record export allowance. What you do with a key can: API and MCP requests that return person records count as record exports.

A key doesn't come with its own allowance. All keys in an organization share that organization's plan.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.