# For AI agents

These docs are built to be consumed by AI coding assistants. Point your agent at them and it can [scaffold a Cherry integration end to end](https://portal.cherry.fun/docs/quickstart.md).

## llms.txt

[`llms.txt`](https://portal.cherry.fun/llms.txt) is a single plain-text file that indexes and links every page in these docs, plus the key facts (package name, API base URL, token format) up front, structured the way LLMs read best. It follows the [llms.txt convention](https://llmstxt.org).

```
https://portal.cherry.fun/llms.txt
```

**How to use it:** paste that URL (or the file's contents) into your AI assistant before asking it to integrate Cherry - in Cursor, Claude, or similar, it becomes context the model can pull the right API and SDK details from. Agents that can browse can fetch it directly. It's the fastest way to give an assistant accurate, current knowledge of the whole API surface without copying pages one by one.

## Integration skills

Cherry ships ready-made **agent skills** (`SKILL.md` files for tools like Claude Code) that turn "add Cherry chat to my app" into a guided, correct integration: the right auth mode, backend token signing, theming, events, and security rules.

| Skill | Use it for | Source |
|---|---|---|
| `cherry-embed-integration` | Embedding Cherry chat with `@cherrydotfun/chat-embed-sdk` (web, React Native, Flutter) | [cherrydotfun/chat-embed-sdk](https://github.com/cherrydotfun/chat-embed-sdk/tree/main/skills) |
| `cherry-miniapp-integration` | Running an existing dApp inside Cherry with `@cherrydotfun/miniapp-sdk` | [cherrydotfun/miniapp-sdk](https://github.com/cherrydotfun/miniapp-sdk/tree/main/skills) |

If your assistant supports skills, install the one that matches your task and ask it to integrate Cherry: it will follow the same patterns documented here.

## Setup prompt

The embed editor in the [dashboard](https://portal.cherry.fun/dashboard) generates a ready-to-paste setup prompt tailored to your embed (its `appId`, auth mode, and theme). Copy it into your AI assistant to scaffold the mount code for your exact configuration.

## Tips for accurate output

- The npm package is **[`@cherrydotfun/chat-embed-sdk`](https://portal.cherry.fun/docs/embed/installation.md)**; the class is **`CherryEmbed`**.
- The [Cherry API](https://portal.cherry.fun/docs/api/authentication.md) has two surfaces: the **Apps API** at **`https://api.cherry.fun/api/v1/apps`** (auth **`Bearer cherry_sk_<projectId>_<secret>`**, a project key) and the **Bot API** at **`https://api.cherry.fun/api/v1/bots`** (auth **`Bearer cherry_bot_<botId>_<secret>`**, a bot key). Each key is **one opaque token** copied from the portal, never assembled from an app ID plus a secret. `cha_<id>_<secret>` is a deprecated legacy format.
- Bot moderation is gated by **two** layers: the `bots:groups:moderate` scope **and** the bot's in-room role (owner/admin/moderator) - see [Members & moderation](https://portal.cherry.fun/docs/api/members.md).
- Keep API keys and the **app secret** server-side: the secret signs embed tokens; API keys authenticate the Cherry API.