# BloomText API

> REST API, webhooks, MCP server, and CLI for reading and sending messages in BloomText, HIPAA-compliant messaging for healthcare teams. Base URL: https://api.bloomtext.com/v1. Authenticate with an organization-scoped API key as a Bearer token; keys are issued to organizations with a signed BAA.

Every page is also available as Markdown at the links below. The full text of all pages is at https://www.bloomtext.com/developers/api/llms-full.txt, and the OpenAPI 3.1 spec is at https://www.bloomtext.com/developers/api/openapi/bloomtext-api.yaml.

## Docs

- [BloomText API](https://www.bloomtext.com/developers/api/index.md): Read and send messages in BloomText conversations from your own software, AI agents, and scripts.
- [Quickstart](https://www.bloomtext.com/developers/api/quickstart.md): Make your first BloomText API request and send a message in five minutes.
- [Core concepts](https://www.bloomtext.com/developers/api/concepts.md): App users, conversations, and the other building blocks of the BloomText API.
- [Authentication](https://www.bloomtext.com/developers/api/authentication.md): Authenticate BloomText API requests with organization-scoped API keys, scopes, and revocation.
- [Webhooks](https://www.bloomtext.com/developers/api/webhooks.md): Receive signed BloomText webhook events when messages, reactions, participants, or exports change.
- [Build an AI agent](https://www.bloomtext.com/developers/api/ai-agents.md): Build an AI agent that reads and replies in BloomText conversations, with safe scopes and human handoff.
- [Send appointment reminders](https://www.bloomtext.com/developers/api/guides/appointment-reminders.md): Send next-day appointment reminders into BloomText conversations from your EMR or scheduling system.
- [Handle patient replies](https://www.bloomtext.com/developers/api/guides/handle-replies.md): Use BloomText webhooks to turn patient replies into actions, like confirming an appointment in your EMR.
- [Export conversation history](https://www.bloomtext.com/developers/api/guides/export-history.md): Export a BloomText conversation's messages on a schedule and file them with the patient's record.
- [MCP server](https://www.bloomtext.com/developers/api/mcp.md): Connect Claude, ChatGPT, Cursor, VS Code, Codex, or any MCP client to BloomText with the BloomText MCP server.
- [CLI](https://www.bloomtext.com/developers/api/cli.md): Use the bloomtext command-line tool to read and send BloomText messages from scripts, cron jobs, and AI coding agents.
- [Docs for AI agents](https://www.bloomtext.com/developers/api/llms.md): Machine-readable BloomText API docs for LLMs and coding agents, including llms.txt, per-page Markdown, and the OpenAPI spec.
- [Pagination](https://www.bloomtext.com/developers/api/pagination.md): Page through BloomText API list endpoints with opaque cursors, page[limit], and page[after].
- [Idempotency](https://www.bloomtext.com/developers/api/idempotency.md): Safely retry BloomText API writes with the Idempotency-Key header.
- [Errors](https://www.bloomtext.com/developers/api/errors.md): BloomText API error responses, HTTP status codes, and machine-readable error codes.
- [Rate limits](https://www.bloomtext.com/developers/api/rate-limits.md): BloomText API rate limits, rate limit headers, and how to stay under them.
- [Security and BAA](https://www.bloomtext.com/developers/api/security-and-baa.md): How the BloomText API protects patient data, and the BAA required for API access.
- [Changelog](https://www.bloomtext.com/developers/api/changelog.md): Dated changes to the BloomText API, MCP server, CLI, and these docs, including new endpoints, fields, and behavior changes.

## API reference

- [API reference](https://www.bloomtext.com/developers/api/reference.md): Every BloomText API endpoint, object, and webhook event, with parameters, example requests, and responses.
- [The Organization object](https://www.bloomtext.com/developers/api/reference/organization-object.md): Attributes of a BloomText Organization and the endpoints that return it.
- [Retrieve the organization](https://www.bloomtext.com/developers/api/reference/get-organization.md): Returns the ID and name of the organization that owns the API key. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [The User object](https://www.bloomtext.com/developers/api/reference/user-object.md): Attributes of a BloomText User and the endpoints that return it.
- [List users](https://www.bloomtext.com/developers/api/reference/list-users.md): Lists the members of your organization. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [Retrieve a user](https://www.bloomtext.com/developers/api/reference/get-user.md): Returns a single member of your organization. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [The Conversation object](https://www.bloomtext.com/developers/api/reference/conversation-object.md): Attributes of a BloomText Conversation and the endpoints that return it.
- [List conversations](https://www.bloomtext.com/developers/api/reference/list-conversations.md): Lists the conversations your app user is a participant in. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [Retrieve a conversation](https://www.bloomtext.com/developers/api/reference/get-conversation.md): Returns a conversation your app user participates in. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [The Message object](https://www.bloomtext.com/developers/api/reference/message-object.md): Attributes of a BloomText Message and the endpoints that return it.
- [List messages](https://www.bloomtext.com/developers/api/reference/list-messages.md): Lists messages in a conversation, oldest first. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [Send a message](https://www.bloomtext.com/developers/api/reference/create-message.md): Sends a text or file message as your app user. Set reply_to_message_id to reply in a thread.
- [List replies to a message](https://www.bloomtext.com/developers/api/reference/list-replies.md): Lists the replies to a message, oldest first. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [The Reaction object](https://www.bloomtext.com/developers/api/reference/reaction-object.md): Attributes of a BloomText Reaction and the endpoints that return it.
- [List reactions](https://www.bloomtext.com/developers/api/reference/list-reactions.md): Lists the emoji reactions on a message. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [Add a reaction](https://www.bloomtext.com/developers/api/reference/create-reaction.md): Adds an emoji reaction to a message as your app user. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [Remove a reaction](https://www.bloomtext.com/developers/api/reference/delete-reaction.md): Removes your app user's reaction from a message. Reactions have no ID of their own, so pass the exact emoji you added.
- [The Participant object](https://www.bloomtext.com/developers/api/reference/participant-object.md): Attributes of a BloomText Participant and the endpoints that return it.
- [List conversation participants](https://www.bloomtext.com/developers/api/reference/list-participants.md): Lists the participants in a conversation. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [Add a participant](https://www.bloomtext.com/developers/api/reference/add-participant.md): Adds a member of your organization to a conversation. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [Remove a participant](https://www.bloomtext.com/developers/api/reference/remove-participant.md): Removes a participant from a conversation. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [The Broadcast object](https://www.bloomtext.com/developers/api/reference/broadcast-object.md): Attributes of a BloomText Broadcast and the endpoints that return it.
- [List broadcasts](https://www.bloomtext.com/developers/api/reference/list-broadcasts.md): Lists your organization's broadcasts. Reading broadcasts does not give access to the conversations they were sent to.
- [Retrieve a broadcast](https://www.bloomtext.com/developers/api/reference/get-broadcast.md): Returns a broadcast and its delivery status. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [List broadcast messages](https://www.bloomtext.com/developers/api/reference/list-broadcast-messages.md): Lists the messages sent by a broadcast. Parameters, responses, and code examples in cURL, JavaScript, Python, Go, and Ruby.
- [The Export object](https://www.bloomtext.com/developers/api/reference/export-object.md): Attributes of a BloomText Export and the endpoints that return it.
- [Export a conversation](https://www.bloomtext.com/developers/api/reference/create-chat-export.md): Starts an asynchronous export of one conversation. Poll the export, or listen for the export.ready webhook, to get the download URL.
- [Retrieve an export](https://www.bloomtext.com/developers/api/reference/get-chat-export.md): Returns the status of an export and, once it is ready, a short-lived download URL.
- [Webhook events](https://www.bloomtext.com/developers/api/reference/webhook-events.md): Every webhook event type the BloomText API sends, with its signed envelope, payload fields, and an example.