# Pharos

> Marketing command center for the apps you ship — contacts, email campaigns,
> drip automations, mention monitoring, social, revenue and reviews, scoped per
> project and reachable over one HTTP API.

The API is the product surface; the dashboard is a review surface. These pages
are the contract, written to be read by an integrator or by the agent building
the integration.

Two things worth knowing before you read further:

- Delivery is gated by a separate credential scope from drafting. An agent key
  carries `campaigns:preview` and `events:write` but not `campaigns:send` or
  `events:send`, so a model can compose, resolve recipients and render — and
  cannot send.
- Product facts stay deterministic. The LLM is confined to bounded language
  generation, and every generation is audited.

Every page below is also served as HTML at https://pharosbase.com/docs, and to MCP clients
as a `pharos://docs/<slug>` resource.

## Getting started

- [Overview](https://pharosbase.com/docs/index.md): What Pharos is, how the pieces fit together, and where to start.
- [Quickstart](https://pharosbase.com/docs/quickstart.md): From an API key to a previewed, then delivered, email in about ten minutes.
- [Core concepts](https://pharosbase.com/docs/concepts.md): Organizations, projects, contacts, lists, templates, campaigns, sends and events.

## Platform

- [Authentication & keys](https://pharosbase.com/docs/authentication.md): The three credential paths, the scope model, and why an agent key cannot send.
- [Workspaces & roles](https://pharosbase.com/docs/workspaces.md): What owners, admins and members can each do, how invitations work, and what deletion takes with it.
- [API conventions](https://pharosbase.com/docs/conventions.md): Base URL, project identifiers, status codes, errors, rate limits and idempotency.

## Guides

- [Sending & deliverability](https://pharosbase.com/docs/sending-providers.md): Connect your own Resend or Amazon SES account, wire up delivery tracking, and get a domain ready to send.
- [Sending a campaign](https://pharosbase.com/docs/campaigns.md): Draft, resolve recipients, preview, test and send — and what an agent can do without being able to deliver.
- [Contact sync](https://pharosbase.com/docs/contact-sync-api.md): Authentication, idempotency, suppression rules and the request contract for keeping contacts in sync from a source application.
- [Transactional events](https://pharosbase.com/docs/llm-and-transactional-events.md): Project brand context, the structured-output LLM gateway, project API keys, and the transactional event contract.
- [Automations](https://pharosbase.com/docs/pharos-automations.md): Multi-step drip sequences, tag triggers, and the contact event webhook.
- [Beacons](https://pharosbase.com/docs/beacons.md): Watch Reddit, Hacker News and Bluesky for mentions — and why hit text is untrusted input to an agent.
- [Unsubscribes & suppression](https://pharosbase.com/docs/compliance.md): How consent is recorded, what one-click unsubscribe guarantees, and why a bulk sync cannot resurrect a suppression.
- [Troubleshooting](https://pharosbase.com/docs/troubleshooting.md): The failures that actually happen — auth, scopes, undelivered mail, literal tokens, silent automations — and what each means.

## API reference

- [Projects & organizations](https://pharosbase.com/docs/api-projects.md): The organization-key bootstrap surface: list organizations, list projects, create a project.
- [Contacts](https://pharosbase.com/docs/api-contacts.md): Read, create, update and delete contacts, change list subscriptions, import and export.
- [Lists](https://pharosbase.com/docs/api-lists.md): Create and manage the audiences within a project, and the slugs recipientMode refers to.
- [Email templates](https://pharosbase.com/docs/api-templates.md): Stored templates, the per-recipient render path, and the interpolation tokens that resolve.
- [Campaigns & sending](https://pharosbase.com/docs/api-campaigns.md): List campaigns with delivery stats, preview a send without delivering it, and read the send log.
- [Automations API](https://pharosbase.com/docs/api-automations.md): Read automations, steps and run history, and the two ways to fire a tag trigger.
- [Insights](https://pharosbase.com/docs/api-insights.md): Beacons, revenue metrics and store reviews — the read-only insights:read surface.

## Agents

- [MCP server](https://pharosbase.com/docs/mcp-server.md): Connect a coding agent to Pharos over hosted HTTP or stdio, and the scope model that keeps it from sending.

## Optional

- [Full documentation, inlined](https://pharosbase.com/llms-full.txt): every page above concatenated into one document.
- [MCP endpoint](https://pharosbase.com/api/mcp): Streamable HTTP, bearer-key authenticated.