API reference
The BloomText API is a REST API with JSON request and response bodies, standard HTTP status codes, and bearer-token authentication. Everything on these pages is generated from the OpenAPI 3.1 spec, which you can also feed to any client generator.
Base URL
https://api.bloomtext.com/v1New to the API? Start with the Quickstart, then read Authentication for keys and scopes.
Resources
Conventions
- Authentication: send
Authorization: Bearer bt_live_…on every request. See Authentication. - IDs: every object has a stable UUID
id. - Timestamps: RFC 3339 strings in UTC, like
2026-09-21T12:00:00Z. - Lists: cursor-paginated with
page[limit]andpage[after]. See Pagination. - Writes: every
POSTtakes anIdempotency-Key. See Idempotency. - Errors: RFC 9457 problem details. See Errors.
All endpoints
Organization
| Method | Path | Endpoint |
|---|---|---|
| GET | /organization | Retrieve the organization |
Users
| Method | Path | Endpoint |
|---|---|---|
| GET | /users | List users |
| GET | /users/{userId} | Retrieve a user |
Conversations
| Method | Path | Endpoint |
|---|---|---|
| GET | /conversations | List conversations |
| GET | /conversations/{conversationId} | Retrieve a conversation |
Messages
| Method | Path | Endpoint |
|---|---|---|
| GET | /conversations/{conversationId}/messages | List messages |
| POST | /conversations/{conversationId}/messages | Send a message |
| GET | /messages/{messageId}/replies | List replies to a message |
Reactions
| Method | Path | Endpoint |
|---|---|---|
| GET | /messages/{messageId}/reactions | List reactions |
| POST | /messages/{messageId}/reactions | Add a reaction |
| DELETE | /messages/{messageId}/reactions | Remove a reaction |
Participants
| Method | Path | Endpoint |
|---|---|---|
| GET | /conversations/{conversationId}/participants | List conversation participants |
| POST | /conversations/{conversationId}/participants | Add a participant |
| DELETE | /conversations/{conversationId}/participants/{userId} | Remove a participant |
Broadcasts
| Method | Path | Endpoint |
|---|---|---|
| GET | /broadcasts | List broadcasts |
| GET | /broadcasts/{broadcastId} | Retrieve a broadcast |
| GET | /broadcasts/{broadcastId}/messages | List broadcast messages |
Exports
| Method | Path | Endpoint |
|---|---|---|
| POST | /conversations/{conversationId}/exports | Export a conversation |
| GET | /exports/{exportId} | Retrieve an export |
Last updated on