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

# API Reference

> Complete reference for the QRKit API

## Base URL

```
https://api.useqrkit.com/v1
```

## Authentication

All endpoints require a Bearer token in the `Authorization` header. See [Authentication](/authentication) for details.

## Resources

<CardGroup cols={2}>
  <Card title="QR Codes" icon="qrcode" href="/api-reference/qr-codes/create">
    Create, read, update, delete, and download QR codes.
  </Card>

  <Card title="Batches" icon="layer-group" href="/api-reference/batches/create">
    Create multiple QR codes in a single request.
  </Card>

  <Card title="Folders" icon="folder" href="/api-reference/folders/create">
    Organize QR codes into folders.
  </Card>

  <Card title="Tokens" icon="key" href="/api-reference/tokens/create">
    Manage API keys programmatically.
  </Card>
</CardGroup>

## Endpoints

### QR Codes

| Method   | Endpoint                      | Description                                            |
| -------- | ----------------------------- | ------------------------------------------------------ |
| `POST`   | `/v1/qr-codes`                | [Create a QR code](/api-reference/qr-codes/create)     |
| `GET`    | `/v1/qr-codes`                | [List QR codes](/api-reference/qr-codes/list)          |
| `GET`    | `/v1/qr-codes/{id}`           | [Retrieve a QR code](/api-reference/qr-codes/retrieve) |
| `PATCH`  | `/v1/qr-codes/{id}`           | [Update a QR code](/api-reference/qr-codes/update)     |
| `DELETE` | `/v1/qr-codes/{id}`           | [Delete a QR code](/api-reference/qr-codes/delete)     |
| `GET`    | `/v1/qr-codes/{id}/download`  | [Download QR image](/api-reference/qr-codes/download)  |
| `GET`    | `/v1/qr-codes/{id}/analytics` | [QR code analytics](/api-reference/qr-codes/analytics) |

### Batches

| Method | Endpoint                    | Description                                              |
| ------ | --------------------------- | -------------------------------------------------------- |
| `POST` | `/v1/batches`               | [Create a batch](/api-reference/batches/create)          |
| `GET`  | `/v1/batches`               | [List batches](/api-reference/batches/list)              |
| `GET`  | `/v1/batches/{id}`          | [Get batch status](/api-reference/batches/retrieve)      |
| `GET`  | `/v1/batches/{id}/download` | [Download batch as ZIP](/api-reference/batches/download) |

### Folders

| Method   | Endpoint           | Description                                      |
| -------- | ------------------ | ------------------------------------------------ |
| `POST`   | `/v1/folders`      | [Create a folder](/api-reference/folders/create) |
| `GET`    | `/v1/folders`      | [List folders](/api-reference/folders/list)      |
| `PATCH`  | `/v1/folders/{id}` | [Update a folder](/api-reference/folders/update) |
| `DELETE` | `/v1/folders/{id}` | [Delete a folder](/api-reference/folders/delete) |

### Tokens

| Method   | Endpoint            | Description                                       |
| -------- | ------------------- | ------------------------------------------------- |
| `POST`   | `/v1/tokens`        | [Create an API key](/api-reference/tokens/create) |
| `GET`    | `/v1/tokens`        | [List API keys](/api-reference/tokens/list)       |
| `DELETE` | `/v1/tokens/{id}`   | [Revoke an API key](/api-reference/tokens/revoke) |
| `POST`   | `/v1/tokens/rotate` | [Rotate an API key](/api-reference/tokens/rotate) |
