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

# Authentication & API Keys

Every API request — REST or gRPC — is signed with a **scoped API key**. Create, scope, rotate, and revoke keys in [Settings → API Keys](/settings/api-keys.md); this page covers how requests are signed.

## What a request carries

* **`X-API-Key`** — your key (format `chirp_<key>`), on every request.
* **`X-Organization-Id`** — your home; it has to match the home the key was made in. Some calls also accept it as an `organizationId` query value instead of the header.

Requests always go over a secure connection.

## Scopes keep keys narrow

A key only does what you let it. Most scopes come in a **Read** and a **Write** form; a few — like telemetry and subscription data — are read-only. You choose them when you create the key, so give a key only what it needs — a spreadsheet export only needs Read. Each call in the [API reference](https://api.chirpwireless.io/) lists the scope it requires.

## Keeping keys safe

* The full key shows **once** when you create it; after that only a short prefix is visible. Copy it into a password manager straight away.
* Use a **different key for each tool**, so you can switch one off without breaking the rest.
* If a key might have leaked, **revoke or rotate** it right away — a lost key can't be recovered, only replaced.
* Never paste a key into a public script, a shared sheet, or version control.


---

# 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, and the optional `goal` query parameter:

```
GET https://docs.chirpwireless.io/api/authentication-and-api-keys.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
