# Revdoku Docs

AI agents can read and search this site:

- [MCP server](/mcp): the tools search_docs, read_page and list_pages. Streamable HTTP, no sign-in.
- [Search](/_revdoku/search?q=example): JSON results with the page, the matching section and a snippet.
- [Every page in one file](/llms-full.txt)
- [Sitemap](/sitemap.xml)
- Each page is Markdown at its URL with `.md` in place of the last slash (`/guides/setup.md`), or send `Accept: text/markdown`.

## Get started

- [Revdoku documentation](/index.md): Publish docs sites from GitHub, connect AI agents, and work with buckets, files and support email through the API, SDKs, CLI and MCP.
- [API quickstart](/quickstart.md): Publish a docs site from your code, check that AI agents can read it, then read the email that its readers send.
- [Docs sites](/docs-sites.md): Publish a GitHub repository as a docs site with search, Ask AI, an API console, an MCP server for AI agents and a support mailbox.
- [Build with Claude Code or Codex](/coding-agents.md): A setup prompt and rules for Claude Code, Codex and other coding agents that write code for the Revdoku API.

## Guides

- [Buckets, email and files](/buckets.md): Create buckets, read and answer support email, store files, check limits and share access with the API, CLI and MCP.
- [Revdoku API](/api.md): Concepts and workflows of the REST API: buckets, docs sites, files and support email, with TypeScript, Python and HTTP examples.
- [Authentication for existing accounts](/guides/authentication.md): How the Revdoku CLI and AI agents sign in to an existing account with OAuth and email codes.
- [Bulk file uploads](/guides/bulk-uploads.md): Upload a docs folder or many files to a bucket with an upload session.
- [Ticket events](/guides/email-events.md): Get new support tickets and their messages as signed webhooks or a live WebSocket subscription, with signature checks and retries.
- [Custom email domains](/guides/custom-email-domains.md): Connect your own email domain in the dashboard, then create buckets with addresses on it through the API.
- [Customer buckets for your SaaS](/guides/saas-mailboxes.md): Give each customer of your application a private bucket: provision it, process arrivals, estimate capacity and recover.
- [Revdoku packages and integrations](/guides/api-packages.md): Choose the TypeScript or Python SDK, n8n, Zapier, the CLI or MCP to work with buckets, docs sites and support email.

## API reference

- [API reference](/api-reference.md): Every operation of the Revdoku REST API with its TypeScript and Python SDK call, grouped by resource.
- [API console](/api-reference/console.md): Try the API in the browser
- [Authentication API reference](/api-reference/authentication.md): Sign-in helpers for the CLI and AI agents. Backend applications use an API key from the dashboard.
- [Accounts API reference](/api-reference/accounts.md): Connection status, granted accounts and limits.
- [Buckets API reference](/api-reference/buckets.md): Create, read, archive and delete buckets.
- [Tickets API reference](/api-reference/tickets.md): Support tickets: each conversation that someone started with the bucket, by email, a message left on the docs site or page feedback. Read them, reply to the requester, solve and label them.
- [Events API reference](/api-reference/events.md): Ticket events of every channel: one signed webhook per bucket and live WebSocket subscriptions.
- [Files API reference](/api-reference/files.md): Upload, read, organize and restore files.
- [Publications API reference](/api-reference/publications.md): A bucket's site: publish its files, preview them for 24 hours, or take the site down.
- [GitHub API reference](/api-reference/github.md): Connect a GitHub repository to a bucket: its files become a copy of one branch, and each push updates them.

## SDKs and tools

- [Revdoku TypeScript SDK](/sdks/typescript.md): Install the revdoku npm package to work with buckets, docs sites, files and support email from Node.js.
- [Revdoku Python SDK](/sdks/python.md): Install the revdoku Python package to work with buckets, docs sites, files and support email.
- [Revdoku MCP](/mcp.md): Connect AI apps to your Revdoku account at mcp.revdoku.com to publish docs and read support email.
- [Revdoku CLI](/cli.md): Install the revdoku command-line tool. Publish docs sites and previews, upload files and read and answer support tickets from your terminal.