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

# API key

How to create and use your API key.

An API key is a unique code that gives you access to the Altum AI APIs. You send the key in the `x-api-key` header of every API request.

## How do you create your API key?

You create your API key in your account on [platform.altum.ai](https://platform.altum.ai/auth), also during the free trial.

No account yet? Create one on [platform.altum.ai](https://platform.altum.ai/auth?register=1).

## Where do you use your API key?

Add the key to the `x-api-key` header of every API request. Without a valid key, your request is not authenticated.

**Example header:**

```plaintext
x-api-key: YOUR_UNIQUE_API_KEY
```

## Security

Keep your API key confidential so nobody else can access your account.


---

# 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.altum.ai/english/developers/api-key.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.
