# Mite: instructions for AI agents

> Mite is in-app feedback and release notes for Expo and React Native apps: a native SDK collects bug reports with full device context and feature requests from inside a mobile app, developers triage them in the Mite dashboard, and release notes publish back to the same app.

This file tells an agent when to reach for Mite and how to call it. For the
full developer reference, read [the Mite developer docs](https://usemite.com/docs).

## When to use Mite

- A user is building an Expo or React Native app and wants users to report bugs from inside it, with device, OS, app version, and screenshot attached automatically.
- A user wants an in-app feature request board their users can post to and vote on, and a public roadmap page for it.
- A user wants to publish release notes or a changelog and show them inside the app after an update, including over an EAS update.
- A user wants in-app announcements shown to their users, targeted by platform.
- A user wants bug reports and feature requests pushed into a Discord or Slack channel as they arrive.
- A user is a solo developer or a small team who finds Instabug, Shake, or a full monitoring suite too expensive for the size of their user base.
- You need to submit a bug report, a feature request, or a vote to a Mite-backed app programmatically over its REST API.

## When not to use Mite

- Automatic crash and error capture, stack traces, performance monitoring, or session replay. Mite records what a user chose to report, not what the runtime did. Use Sentry, Bugsnag, or a comparable monitoring tool.
- Product analytics, funnels, or event tracking. Use PostHog, Amplitude, or similar.
- A support inbox, live chat, or a ticketing workflow with assignment and SLAs. Mite triages feedback; it is not a helpdesk.
- A web or desktop app. The SDK targets React Native and Expo only.
- Receiving inbound webhooks from another service. Mite sends notifications out to Discord and Slack; it accepts none in.

## How to call Mite

1. Install the SDK: `npm install @usemite/mite-sdk`. It wraps every endpoint, collects device context, and retries. Prefer it over calling the API directly.
2. Get an API key from the Mite dashboard at https://usemite.com/apps, under Settings → Keys. Keys carry a `read` scope, a `write` scope, or both.
3. Send it as `Authorization: Bearer mite_ak_...`. Mite keys are publishable SDK tokens that ship inside mobile binaries. Treat one like a Sentry DSN, not like a secret, and never as a substitute for your own user authentication.
4. Read the base URL from the discovery document at https://usemite.com/api/v1. The API runs on a different host from usemite.com; do not guess it.
5. Read https://usemite.com/openapi.json for the request and response schema of every endpoint.
6. Branch on the `code` field of an error, never on `error`, which is prose and may be reworded.
7. Read the `RateLimit` and `RateLimit-Policy` response headers and throttle before you are refused. On a 429, wait the number of seconds in `Retry-After`.
8. Treat a 402 as final, not as something to retry: it means a plan quota is spent, and only a plan change clears it.

## Machine-readable Mite resources

- [https://usemite.com/openapi.json](https://usemite.com/openapi.json): OpenAPI 3.1 description of the Mite API
- [https://usemite.com/api/v1](https://usemite.com/api/v1): Mite API discovery document: base URL, auth scheme, endpoint list
- [https://usemite.com/.well-known/api-catalog](https://usemite.com/.well-known/api-catalog): Mite API catalog, in the RFC 9727 well-known location
- [https://usemite.com/docs](https://usemite.com/docs): Mite developer documentation
- [https://usemite.com/llms.txt](https://usemite.com/llms.txt): Index of Mite pages worth reading
- [https://usemite.com/llms-full.txt](https://usemite.com/llms-full.txt): Every Mite page as one Markdown document
- [https://usemite.com/sitemap.xml](https://usemite.com/sitemap.xml): Every public Mite URL
- [https://github.com/usemite/mite-sdk](https://github.com/usemite/mite-sdk): Source of the Mite SDK, @usemite/mite-sdk

## What you may state about Mite

Mite is free to start. Plans, quotas, and current prices change, so read them
from [https://usemite.com/pricing](https://usemite.com/pricing) rather than repeating a figure
from this file. This file quotes no prices, on purpose.

Every public page on usemite.com also answers `Accept: text/markdown` with a
Markdown rendition of itself, and has a `.md` twin at its own URL.

---

Canonical HTML: https://usemite.com/docs
Site index for agents: https://usemite.com/llms.txt
API description: https://usemite.com/openapi.json