> For the complete documentation index, see [llms.txt](https://docs.lumidb.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lumidb.com/archive-management/api-keys.md).

# API keys

Create, use and revoke API keys for streaming links, scripts and AI assistants.

An API key lets a tool act as you in LumiDB. You need one to stream data into ArcGIS, QGIS or a 3D tiles viewer, to call the REST API from a script, and to connect an AI assistant. The key has the same access to projects as you do.

### Create an API key

1. In the sidebar of the home view, under **Admin**, click **API keys**. You can also click **Create API key** in the dialog of a streaming link, for example **ArcGIS I3S link**.
2. Click **Create API key**.
3. Enter a **Name** that tells you what the key is for, for example `ArcGIS Pro` or `QGIS rasters`.
4. Under **Project access**, leave **All projects**, or pick one project to limit the key to it.
5. Choose when the key **Expires**: **Never**, **1 day**, **7 days**, **30 days** or **Custom**.
6. Click **Create API key** and copy the key.

<div align="left"><figure><img src="https://150512722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMI9s5xLuAdXOTKpfljc3%2Fuploads%2Fh54J7yxwZADxv03ilCB5%2F02-new-api-key.png?alt=media" alt="The New API key dialog with Name, Project access and Expires fields" width="484"><figcaption><p>The New API key dialog.</p></figcaption></figure></div>

{% hint style="danger" %}
LumiDB shows the key only once, right after you create it. Copy it to a password manager straight away. If you lose it, revoke it and create a new one. Don't share a key by email or chat, and never put one in a document or screenshot.
{% endhint %}

A key starts with `lumi_`, followed by random characters. In this documentation, `lumi_your_key_here` stands for your own key.

### What a key can access

* A key can reach the same projects and data as the person who created it, in the organization where it was created.
* If your role in the organization or a project changes, the key follows. If you are removed from the organization, the key stops working.
* A key can be limited to one project. A project-scoped key reaches only that project and has no organization-level rights. A key can't be read-only. Give a key only to tools you trust.

{% hint style="info" %}
Changes to a key can take up to a minute to take effect. Changes to project access and organization membership take effect immediately.
{% endhint %}

### Use an API key

LumiDB accepts the key in four ways. Use the first whenever your tool allows it.

| Method                | How to send the key                                                                                                                            | Typical use                                                  |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| HTTP header           | `Authorization: apikey lumi_your_key_here`                                                                                                     | Scripts, QGIS authentication configurations, the REST API    |
| Other HTTP headers    | The key as the value of an `apikey`, `api-key`, `x-apikey` or `x-api-key` header.                                                              | Clients that don't let you change the `Authorization` header |
| Username and password | Any username, and the key as the password. ArcGIS Pro asks for these in its **Server Login** window, where you enter `apikey` as the username. | ArcGIS Pro                                                   |
| Query parameter       | Add `apikey=lumi_your_key_here` to the link. This works only when no header is sent.                                                           | ArcGIS Online custom parameter                               |

See [Integrations](https://docs.lumidb.com/integrations.md) for step-by-step instructions, and [Connecting AI assistants (MCP)](https://docs.lumidb.com/integrations/connecting-ai-assistants-mcp.md) for assistants.

### Manage your keys

The **API keys** page lists your keys in the organization. For each key it shows the name, the project it can reach, when it was created, when it expires, when it was last used and its status.

<figure><img src="https://150512722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMI9s5xLuAdXOTKpfljc3%2Fuploads%2FTVMFfRX9YnERANwpCPDG%2F01-api-keys-list.png?alt=media" alt="The API keys list with Name, Project access, Created, Expires, Last used and Status columns"><figcaption><p>The API keys page.</p></figcaption></figure>

To revoke a key, click the trash icon at the end of its row. The status changes to **Revoked**, and tools that use the key lose access. A revoked key can't be restored.

{% hint style="info" %}
Create one key for each tool or person, and give it a descriptive name. Then you can revoke one without breaking the others, and **Last used** shows which keys are still in use. For temporary access, choose a short expiry.
{% endhint %}

### Limits

* Keys are personal. You can limit a key to one project, but you can't set other permissions per key.
* Short-lived tokens for showing selected datasets in your own web application are available through the API. Only organization admins can create them, and each token works for a few minutes. Contact <help@lumidb.com> if you need this.

Questions? Write to <help@lumidb.com>.


---

# 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.lumidb.com/archive-management/api-keys.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.
