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

# Getting Started

## API Overview

| Item               | Value                    |
| ------------------ | ------------------------ |
| **Base URL**       | `https://api.odinbot.io` |
| **API key header** | `x-api-key`              |

All request and response bodies are JSON unless stated otherwise.

## Getting your API key

1. Sign in to OdinBot and open **Settings**.

<figure><img src="https://4180950079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fo0Ph0MtrBKe4HScB8L4D%2Fuploads%2F0gv1vi1O8jmU27R2RwPr%2Fapi_key_settings.jpg?alt=media&amp;token=70724433-1c12-4d6b-954a-e603ff4a2a20" alt="" width="563"><figcaption></figcaption></figure>

2. Click **Manage API keys**.

<figure><img src="https://4180950079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fo0Ph0MtrBKe4HScB8L4D%2Fuploads%2FRQay8VJhaVbYutpDl3MP%2Fmanage_api_keys.jpg?alt=media&amp;token=725aec05-1ae1-4daf-b2e8-d74155e93b3e" alt="" width="563"><figcaption></figcaption></figure>

3. In the pop-up, choose **+ Create a new API key**.

<figure><img src="https://4180950079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fo0Ph0MtrBKe4HScB8L4D%2Fuploads%2F29SSYGjTX75v0mHMUH6k%2Fcreate_new_api_key.jpg?alt=media&amp;token=1e19b779-47b8-4c54-8f63-f6270f5328bb" alt="" width="563"><figcaption></figcaption></figure>

4. Copy the key that appears and store it in a safe place.

<figure><img src="https://4180950079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fo0Ph0MtrBKe4HScB8L4D%2Fuploads%2FxfBpTy0Uim2mpNGlWi1p%2Fapi_key.jpg?alt=media&amp;token=079de261-6f93-43c6-b592-75cb1ce8432d" alt="" width="563"><figcaption></figcaption></figure>

## How to revoke access to your API key

1. From OdinBot's interface open **Settings**.

<figure><img src="https://4180950079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fo0Ph0MtrBKe4HScB8L4D%2Fuploads%2F0gv1vi1O8jmU27R2RwPr%2Fapi_key_settings.jpg?alt=media&amp;token=70724433-1c12-4d6b-954a-e603ff4a2a20" alt="" width="563"><figcaption></figcaption></figure>

2. Click **Manage API keys**.

<figure><img src="https://4180950079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fo0Ph0MtrBKe4HScB8L4D%2Fuploads%2FRQay8VJhaVbYutpDl3MP%2Fmanage_api_keys.jpg?alt=media&amp;token=725aec05-1ae1-4daf-b2e8-d74155e93b3e" alt="" width="563"><figcaption></figcaption></figure>

3. In the pop-up, locate the **API key** for which you wish to revoke access, click the **Actions** dropdown button, and then click the **Revoke all access and delete** option.

<figure><img src="https://4180950079-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fo0Ph0MtrBKe4HScB8L4D%2Fuploads%2F8ldYbXTO8jowGZrIWTxw%2Frevoke_api_key.jpg?alt=media&amp;token=cee6c33c-e492-4ace-8524-9dcc23526b63" alt="" width="563"><figcaption></figcaption></figure>

{% hint style="warning" %}
Once the key is removed, any calls made using it will return a **401 Unauthorized error**.
{% endhint %}
