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

# Authentication

> Generate API keys, understand permissions, and manage access

## How to generate an API key

Our API uses header-based authentication. Each request must include a key in the headers to verify your identity and permissions. You can create and manage API keys through the [Quartr Portal](https://portal.quartr.dev).

<Steps titleSize="h3">
  <Step title="Log in to the Portal">
    Access your account by logging into the [Quartr
    Portal](https://portal.quartr.dev).
  </Step>

  <Step title="Navigate to API keys">
    Once signed in, navigate to the API keys section.
  </Step>

  <Step title="Generate a new API key">
    Click "New API Key" to create a key. The new key will appear in the
    list.
  </Step>

  <Step title="Use the API key in requests">
    Include the key in the request headers using `x-api-key` as the header name.
  </Step>

  <Step title="Test the API key">
    Try your new key by exploring the [API Reference](/api-reference).
  </Step>
</Steps>

## Dataset access

Your access to datasets is determined by your subscription plan. Each API key inherits the permissions of your plan. Accessing datasets outside your plan results in a `403 Forbidden` error.

If you are trying to access the `/documents` endpoint, make sure you have permission to access all three document types: `reports`, `slides`, and `transcripts`. Missing any one of these permissions will result in a 403 error. The same applies to the `/live` endpoint, which requires access to both `live transcripts` and `live audio`.

If you have purchased the correct data packages and still receive a 403 error, contact your Quartr representative.

## API key management

API keys do not have an expiration date by default. You can delete them at any time from the "API keys" section in the portal, which immediately revokes access.

## Rate limits

Each API key is subject to rate limits based on your subscription plan. The default rate-limit is **50 requests per second**.

If you exceed the allowed number of requests, you will receive a `429 Too Many Requests` response. The rate limit resets after a certain period, which is specified in the response headers.

<Info>
  If you need a higher rate limit, please contact your Quartr representative to discuss options for increasing your limits based on your use case and subscription plan.
</Info>
