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

# Authentication

## Getting Your Credentials

1. [Install the Release CLI](/cli/installation.md)
2. Run `release auth login`
3. Your credentials are stored in `~/.release.yaml`:

```yaml
login: you@example.com
token: your-api-token
```

> **Note:** The key is `login`, not `email`. This is a common source of confusion when scripting.

You can also retrieve your token from [web.release.com/profile](https://web.release.com/profile).

## User Authentication

Use these headers for most API operations, including all AI Sandbox and GraphQL API calls:

| Header       | Value                          | Description                |
| ------------ | ------------------------------ | -------------------------- |
| X-User-Email | `login` from `~/.release.yaml` | Your Release account email |
| X-User-Token | `token` from `~/.release.yaml` | Your authentication token  |

## Account Authentication

Some Platform API endpoints use account-level credentials instead. Find these values in Account Settings > Account Info:

| Header          | Value         | Description                        |
| --------------- | ------------- | ---------------------------------- |
| X-Account-ID    | Account ID    | Your Release account ID            |
| X-Account-Token | Account token | Account-level authentication token |

## Which Headers to Use

Each endpoint's documentation specifies which authentication method it requires. When in doubt:

* **Platform API:** Most endpoints accept both; account-level auth is required for CI/CD integrations
* **AI Sandbox API:** Always use user authentication (X-User-Email + X-User-Token)
* **GraphQL API:** Always use user authentication (X-User-Email + X-User-Token)


---

# 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.release.com/reference-documentation/release-api/authentication.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.