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

# Authentication

> All Hoplynk API requests authenticate with an API key.

## API Keys

API keys are prefixed with `hlk_` and are issued from the Hoplynk dashboard. Pass your key in the `X-API-Key` header on every request.

```bash theme={null}
curl https://argus.hoplynk.com/api/kits \
  -H "X-API-Key: hlk_..."
```

<Warning>
  API keys are shown only once at creation. Store them securely — treat them like passwords.
</Warning>

## Getting a Key

Log into the [Hoplynk dashboard](https://argus.hoplynk.com) and generate an API key from the API Keys section. Keys are issued per account and scoped to your kits.

## Key Scopes

All partner API keys have the following scopes by default:

| Scope            | Access                                  |
| ---------------- | --------------------------------------- |
| `telemetry:read` | Read kit location, links, and telemetry |
| `assets:read`    | Read assets and their feeds             |

## Environment Variables

We recommend storing your API key and kit ID as environment variables:

```bash theme={null}
export HOPLYNK_API_KEY=hlk_...
export HOPLYNK_KIT_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```