# Mimeo documentation

Mimeo is email automation you own. One install, one customer — yours. These docs cover both halves of how you run it: the web UI you click through, and the API your coding agent talks to.

A note on names: when these docs say **Mimeo**, they mean _your_ Mimeo — your own instance of the app, holding only your data. Hosted, it lives at `your-account-name.mimeoapp.com`; self-hosted, it lives on whatever domain you put it on.

New here? Start with [Getting started](/content/docs/usage/getting-started.html) — six steps from first login to a working operation. Then [How it fits together](/content/docs/how-it-fits/index.html) is the five-minute map of the pieces, and the [glossary](/content/docs/glossary/index.html) has every term.

## Browse the docs

- [Usage](/content/docs/usage/index.html): Working in the app: people, CSV import, authoring emails, and connecting a sending provider.
- [API](/content/docs/api/index.html): The HTTP interface your agent and your app use: events, people, flows, emails, sequences, broadcasts and the manager repo's definition files.
- [MCP server](/content/docs/mcp/index.html): A native tool surface for coding agents, running on your Mimeo. Add it to Claude Code with one command.
- [Manager repo](/content/docs/manager-repo/index.html): Your whole operation as files in a git repo you own — pulled, edited and pushed back by the bundled CLI, never by git.

## How Mimeo is put together

Your Mimeo instance owns the data and the logic — people, custom fields, tags, events, money history, emails, templates, tracking, and the send log all live in your own database. A pluggable **sending provider** handles delivery to the inbox. The **Sending & domains** section covers that whole side, starting with [Set up sending](/content/docs/providers/setup.html) — the wizard every new Mimeo opens with, which connects a provider ([Postmark](/content/docs/providers/postmark.html) or [Resend](/content/docs/providers/resend.html)) and puts the links inside every message on your own [connected sending domain](/content/docs/usage/domains-and-senders.html), not your Mimeo's own hostname.

Everything that enters Mimeo from outside — a signup, a purchase, a renewal, an opt-in — arrives as an [event](/content/docs/api/events.html). That one endpoint upserts the person, records first-touch attribution, appends to their timeline, and writes the money tables. If you learn one thing about the API, learn the event contract.

## What's here today

Mimeo is shipping in stages, and these docs only describe what actually exists. Right now that's: people management and GDPR tooling, CSV import, custom fields and tags, the email library and editor with templates and previews, open and click tracking, the event API, and the subscription-management API — plus the whole automation engine: [sequences](/content/docs/usage/sequences.html), [flows](/content/docs/usage/flows.html) with dry runs and versions, the [scheduled queue](/content/docs/usage/queue.html), [guards](/content/docs/usage/guards.html), send windows, and the [flow API](/content/docs/api/flows.html).

And the daily-driver console: [segments](/content/docs/usage/segments.html) with watchdogs, [broadcasts](/content/docs/usage/broadcasts.html), [reporting](/content/docs/usage/reporting.html) across emails, sequences, flows and broadcasts, [the activity feed and event registry](/content/docs/usage/events.html), [the dashboard](/content/docs/usage/dashboard.html), and [keyboard-first navigation](/content/docs/usage/keyboard.html).

**The agent surface** is here too: [the CLI](/content/docs/cli/index.html) and a manager repo for anything you want reviewed as a diff, [the MCP server](/content/docs/mcp/index.html) for questions and one-off changes, [the manager repo](/content/docs/manager-repo/index.html) that carries both, and [the reference section](/content/docs/reference/index.html) — the flow schema, the event contract, the repo layout and how to write your own sending adapter — written so an agent can operate a Mimeo from the docs alone.