# Cherami

Free email infrastructure for AI agents. Base URL: https://cherami.to

Every documentation page is fetchable as Markdown under https://cherami.to/docs-markdown/<slug>; the links below point there. The complete documentation in one file is at https://cherami.to/llms-full.txt.

## Documentation

- [Start here](https://cherami.to/docs-markdown/overview): One exchange from address to reply, with the call your code makes and the tool your agent uses at each step. Choose your way in at the end.
- [HTTP API quickstart](https://cherami.to/docs-markdown/quickstart): Get an API key, receive a message and reply on the thread, with curl, TypeScript or Python.
- [Connect over MCP](https://cherami.to/docs-markdown/mcp): Add Cherami's hosted MCP server to your agent's application, approve it in your browser, and choose an inbox.
- [Connect the Cherami plugin](https://cherami.to/docs-markdown/plugin): Approve the Cherami plugin in your browser and give your agent an inbox.
- [Accounts, inboxes, and messages](https://cherami.to/docs-markdown/concepts): What one account holds, what every connection to it reaches, and how inboxes, messages, threads and labels fit together.
- [HTTP API reference](https://cherami.to/docs-markdown/api): Authentication, conventions and the public OpenAPI contract.
- [Signup and approval](https://cherami.to/docs-markdown/api/access): HTTP operations for signup and approval.
- [Find the approval page](https://cherami.to/docs-markdown/api/access/discover-signup): POST /v1/signups
- [Redeem an approval phrase](https://cherami.to/docs-markdown/api/access/redeem-claim): POST /v1/claims
- [Saved drafts](https://cherami.to/docs-markdown/api/drafts): HTTP operations for saved drafts.
- [Create a draft](https://cherami.to/docs-markdown/api/drafts/create-draft): POST /v1/inboxes/{inbox_id}/drafts
- [Delete a draft](https://cherami.to/docs-markdown/api/drafts/delete-draft): DELETE /v1/drafts/{draft_id}
- [Retrieve a draft](https://cherami.to/docs-markdown/api/drafts/get-draft): GET /v1/drafts/{draft_id}
- [List drafts](https://cherami.to/docs-markdown/api/drafts/list-drafts): GET /v1/inboxes/{inbox_id}/drafts
- [Send a draft](https://cherami.to/docs-markdown/api/drafts/send-draft): POST /v1/drafts/{draft_id}/send
- [Edit a draft](https://cherami.to/docs-markdown/api/drafts/update-draft): PATCH /v1/drafts/{draft_id}
- [Errors, limits and pagination](https://cherami.to/docs-markdown/api/errors): Error codes and what to do about each, recovery by operation, pagination and limits.
- [Feedback](https://cherami.to/docs-markdown/api/feedback): HTTP operations for feedback.
- [Submit feedback](https://cherami.to/docs-markdown/api/feedback/submit-feedback): POST /v1/feedback
- [Inboxes and rules](https://cherami.to/docs-markdown/api/inboxes): HTTP operations for inboxes and rules.
- [Create an inbox](https://cherami.to/docs-markdown/api/inboxes/create-inbox): POST /v1/inboxes
- [Delete an inbox](https://cherami.to/docs-markdown/api/inboxes/delete-inbox): DELETE /v1/inboxes/{inbox_id}
- [Read an inbox](https://cherami.to/docs-markdown/api/inboxes/get-inbox): GET /v1/inboxes/{inbox_id}
- [Inspect receiving rules](https://cherami.to/docs-markdown/api/inboxes/get-receiving-policy): GET /v1/inboxes/{inbox_id}/receiving-policy
- [Inspect sending rules](https://cherami.to/docs-markdown/api/inboxes/get-sending-policy): GET /v1/inboxes/{inbox_id}/sending-policy
- [List inboxes](https://cherami.to/docs-markdown/api/inboxes/list-inboxes): GET /v1/inboxes
- [Edit inbox names](https://cherami.to/docs-markdown/api/inboxes/update-inbox): PATCH /v1/inboxes/{inbox_id}
- [Labels](https://cherami.to/docs-markdown/api/labels): HTTP operations for labels.
- [Label several received messages](https://cherami.to/docs-markdown/api/labels/bulk-update-message-labels): PATCH /v1/messages/labels
- [Label several sent copies](https://cherami.to/docs-markdown/api/labels/bulk-update-sent-labels): PATCH /v1/sent/labels
- [Discover labels](https://cherami.to/docs-markdown/api/labels/list-labels): GET /v1/inboxes/{inbox_id}/labels
- [Label a received message](https://cherami.to/docs-markdown/api/labels/update-message-labels): PATCH /v1/messages/{message_id}
- [Label a sent copy](https://cherami.to/docs-markdown/api/labels/update-sent-message-labels): PATCH /v1/sent/{message_id}
- [Received messages](https://cherami.to/docs-markdown/api/messages): HTTP operations for received messages.
- [Count received messages](https://cherami.to/docs-markdown/api/messages/count-messages): GET /v1/inboxes/{inbox_id}/messages/count
- [Delete a received message](https://cherami.to/docs-markdown/api/messages/delete-message): DELETE /v1/messages/{message_id}
- [Download a received attachment](https://cherami.to/docs-markdown/api/messages/download-attachment): GET /v1/messages/{message_id}/attachments/{attachment_id}
- [Download raw MIME](https://cherami.to/docs-markdown/api/messages/download-raw-message): GET /v1/messages/{message_id}/raw
- [Read a received message](https://cherami.to/docs-markdown/api/messages/get-message): GET /v1/messages/{message_id}
- [List received messages](https://cherami.to/docs-markdown/api/messages/list-messages): GET /v1/inboxes/{inbox_id}/messages
- [Sending and allowance](https://cherami.to/docs-markdown/api/sending): HTTP operations for sending and allowance.
- [Delete a sent copy](https://cherami.to/docs-markdown/api/sending/delete-sent-message): DELETE /v1/sent/{message_id}
- [Forward a message](https://cherami.to/docs-markdown/api/sending/forward-message): POST /v1/inboxes/{inbox_id}/forward
- [Read sending allowance](https://cherami.to/docs-markdown/api/sending/get-outbound-quota): GET /v1/outbound/quota
- [Read a sent message](https://cherami.to/docs-markdown/api/sending/get-sent-message): GET /v1/sent/{message_id}
- [List sent messages](https://cherami.to/docs-markdown/api/sending/list-sent-messages): GET /v1/inboxes/{inbox_id}/sent
- [Reply to all](https://cherami.to/docs-markdown/api/sending/reply-all-message): POST /v1/inboxes/{inbox_id}/reply-all
- [Reply to a message](https://cherami.to/docs-markdown/api/sending/reply-message): POST /v1/inboxes/{inbox_id}/reply
- [Send a message](https://cherami.to/docs-markdown/api/sending/send-message): POST /v1/inboxes/{inbox_id}/sent
- [Conversations](https://cherami.to/docs-markdown/api/threads): HTTP operations for conversations.
- [Delete a conversation](https://cherami.to/docs-markdown/api/threads/delete-thread): DELETE /v1/threads/{thread_id}
- [Read a conversation](https://cherami.to/docs-markdown/api/threads/get-thread): GET /v1/threads/{thread_id}
- [List conversations](https://cherami.to/docs-markdown/api/threads/list-threads): GET /v1/inboxes/{inbox_id}/threads
- [Label a conversation](https://cherami.to/docs-markdown/api/threads/update-thread-labels): PATCH /v1/threads/{thread_id}
- [Trash](https://cherami.to/docs-markdown/api/trash): HTTP operations for Trash.
- [List Trash](https://cherami.to/docs-markdown/api/trash/list-trash): GET /v1/inboxes/{inbox_id}/trash
- [Restore a received message](https://cherami.to/docs-markdown/api/trash/restore-message): POST /v1/messages/{message_id}/restore
- [Restore a sent copy](https://cherami.to/docs-markdown/api/trash/restore-sent-message): POST /v1/sent/{message_id}/restore
- [Webhooks](https://cherami.to/docs-markdown/api/webhooks): HTTP operations for webhooks.
- [Add a webhook](https://cherami.to/docs-markdown/api/webhooks/create-webhook): POST /v1/webhooks
- [Delete a webhook](https://cherami.to/docs-markdown/api/webhooks/delete-webhook): DELETE /v1/webhooks/{webhook_id}
- [Read a webhook](https://cherami.to/docs-markdown/api/webhooks/get-webhook): GET /v1/webhooks/{webhook_id}
- [Read one event's deliveries](https://cherami.to/docs-markdown/api/webhooks/get-webhook-event): GET /v1/webhooks/events/{event_id}
- [Retrieve the signing secret](https://cherami.to/docs-markdown/api/webhooks/get-webhook-secret): GET /v1/webhooks/{webhook_id}/secret
- [List delivery attempts](https://cherami.to/docs-markdown/api/webhooks/list-webhook-attempts): GET /v1/webhooks/{webhook_id}/attempts
- [List recent events](https://cherami.to/docs-markdown/api/webhooks/list-webhook-events): GET /v1/webhooks/events
- [List custom header names](https://cherami.to/docs-markdown/api/webhooks/list-webhook-headers): GET /v1/webhooks/{webhook_id}/headers
- [List webhooks](https://cherami.to/docs-markdown/api/webhooks/list-webhooks): GET /v1/webhooks
- [Rotate the signing secret](https://cherami.to/docs-markdown/api/webhooks/rotate-webhook-secret): POST /v1/webhooks/{webhook_id}/secret/rotate
- [Edit a webhook](https://cherami.to/docs-markdown/api/webhooks/update-webhook): PATCH /v1/webhooks/{webhook_id}
- [Set or remove custom headers](https://cherami.to/docs-markdown/api/webhooks/update-webhook-headers): PATCH /v1/webhooks/{webhook_id}/headers
- [Answer project questions](https://cherami.to/docs-markdown/cookbooks/answer-project-questions): Automatically answer recurring email questions from a reference you maintain, and set aside requests that need judgment or missing facts.
- [Collect and clarify project updates](https://cherami.to/docs-markdown/cookbooks/project-update-intake): Give recurring project reports a dedicated address, record what changed, and automatically ask contributors for missing information.
- [Work with attachments](https://cherami.to/docs-markdown/guides/attachments): Download received files for your agent to read, or attach a file to a message you send.
- [Change your agent's email address](https://cherami.to/docs-markdown/guides/change-email-address): Move your agent to a new address with a new inbox, keep the old one during the transition, or change only an inbox's names.
- [Read a conversation](https://cherami.to/docs-markdown/guides/conversations): Read received and sent mail in one conversation, and reply to it.
- [Delete and restore mail](https://cherami.to/docs-markdown/guides/deletion): Move messages or conversations to Trash and restore them within seven days, delete drafts or an inbox for good, or request account deletion.
- [Deployment and support requirements](https://cherami.to/docs-markdown/guides/deployment): Cherami is hosted for you; tell us if your work needs a dedicated deployment or service commitments.
- [Prepare and review a draft](https://cherami.to/docs-markdown/guides/drafts): Save an email for review, revise it and send it when it's approved.
- [Organize mail with labels](https://cherami.to/docs-markdown/guides/labels): Label mail and find the messages that belong to a task or category.
- [Share an account across agents](https://cherami.to/docs-markdown/guides/multi-agent): Give each agent its own key and inbox in one account, and hand off work between them by email.
- [Track read, unread and starred mail](https://cherami.to/docs-markdown/guides/read-unread): Mark mail read or starred and find what's unread, in step with the Account.
- [Receive and poll for mail](https://cherami.to/docs-markdown/guides/receiving): Check an inbox for new mail and read it.
- [Block unwanted senders](https://cherami.to/docs-markdown/guides/receiving-rules): Block mail from selected addresses and domains, with rules only you can change.
- [Replace an API key](https://cherami.to/docs-markdown/guides/recovery): Replace a lost or exposed API key without disrupting your other agents.
- [Send and read mail safely](https://cherami.to/docs-markdown/guides/safety): Who your agent may email, how to treat the mail it reads, and how to ask for content screening.
- [Find mail](https://cherami.to/docs-markdown/guides/search): Search words and phrases, combine message filters, and find matching conversations.
- [Send, reply and forward](https://cherami.to/docs-markdown/guides/sending): Send a message, reply to or forward mail, and read the result.
- [Limit an inbox’s recipients](https://cherami.to/docs-markdown/guides/sending-rules): Choose the addresses and domains an inbox may email, with rules only you can change.
- [Get help or request more allowance](https://cherami.to/docs-markdown/guides/support): Report a problem, suggest a feature, or request more inbox slots or sending capacity.
- [Receive webhook notifications](https://cherami.to/docs-markdown/guides/webhooks): Get notified when mail arrives or a send is accepted, verify the delivery, then fetch the message through the API.
- [Use the Python SDK](https://cherami.to/docs-markdown/python): Read, page through and send mail from Python scripts and async applications.
- [Troubleshooting and FAQ](https://cherami.to/docs-markdown/troubleshooting): Fix access problems, missing mail, refused inboxes and sends, and unexpected search results.
- [Use the TypeScript SDK](https://cherami.to/docs-markdown/typescript): Read, page through and send mail from a Node.js backend.