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

# Introduction

> Build, filter, and generate with the KaoriBot API.

<Note>
  To start building with Kaori, you will need an API key. You can generate one in your [Dashboard Settings](https://kaoribot.mikabot.xyz/app/settings).
</Note>

## Welcome

The Kaori API provides developers with high-performance tools for image filtering, meme generation, and community utility. Our API is organized around REST, uses standard HTTP response codes, and returns either JSON-encoded responses or direct binary image data.

Whether you are building a custom Discord bot, a web application, or a creative suite, our endpoints offer a predictable and robust integration path.

<Card title="Kaori API Specification" icon="code" href="https://api-kaori.mikabot.xyz/kaori-api-spec-docs.json">
  View the raw OpenAPI specification file used for these docs.
</Card>

## Authentication

Authentication for the Kaori API is handled via Bearer Tokens. All requests to protected endpoints must include your secret API key in the `Authorization` header.

<Warning>
  Your API keys carry significant privileges. Keep them secure and never expose them in client-side code (browsers, mobile apps, etc.).
</Warning>

```http theme={null}
Authorization: Bearer sk_kaori_your_secret_key_here
```

## Core Concepts

### Response Formats

Kaori responds differently based on the category of the endpoint:

* **Generators/Filters/Overlays**: Successful requests return direct binary image data (`image/png` or `image/jpeg`).
* **Texts/Utils/System**: Successful requests return JSON objects.
* **Errors**: All error states (4xx and 5xx) return a consistent JSON payload for easier debugging.

### Versioning

All current stable endpoints are served under the `/v1` prefix. We follow semantic versioning for breaking changes to ensure stability for your integrations.

```bash theme={null}
https://api-kaori.mikabot.xyz/v1/...
```

## Need Help?

If you encounter any issues or have questions about integration, join our community for real-time assistance:

* **Discord**: Join our support server
* **Email**: [support@kaoribot.com](mailto:support@kaoribot.com)
