API Reference
Changelog
Version history for the RealtimeX API documentation — what was added, clarified, or reorganized.
Overview
This changelog tracks documentation releases for the RealtimeX API reference. Entries describe what readers will find in the docs (new modules, clarified auth, sample envelopes), not every backend commit.
When an API behavior changes in a breaking way, we call that out explicitly so integrators can update clients. Additive endpoint coverage is the most common type of change.
Endpoint pages remain the source of truth for request/response contracts. Use this page to see what landed in each docs revision.
Releases
| Version | Date | Author | Summary |
|---|---|---|---|
| 1.2 | July 19, 2026 | RealtimeX Engineering Team | Settings (Get / Update / Effective), Moderation (List / Resolve / Mute / Ban / Audit Logs), and expanded Reference section (sample requests/responses, status codes, appendix, changelog). |
| 1.1 | July 10, 2026 | RealtimeX Engineering Team | Group conversation endpoints, Block/Unblock User, and Roles coverage expansion across Conversation and User modules. |
| 1.0 | July 10, 2026 | RealtimeX Engineering Team | Initial docs release generated from the RealtimeX Postman collection (Auth, Platform, Dashboard, User, Conversation, Messages, Uploads, and related modules). |
1.2 — July 19, 2026
Added
- Settings — Get Settings, Update Settings (partial PATCH examples including VideoSDK
calls), and Effective Settings. - Moderation — List Reports, Resolve Reports (
message_deleted/dismissed), Mute/Unmute User, Ban/Unban User, and Audit Logs. - Richer Reference pages: Sample requests, Sample responses, Status codes handling guide, Appendix glossary/pagination, and this changelog structure.
Clarified
- Platform admin vs chat SDK token usage across Settings and Moderation.
- Shared response envelope and pagination fields (
list+pagination). - Corrected Status codes descriptions for 403 Forbidden vs 404 Not Found.
1.1 — July 10, 2026
Added
- Group conversation APIs: create group, admins, permissions, information, participants.
- User module: Block / Unblock.
- Expanded Roles documentation (create, list, get).
1.0 — July 10, 2026
Initial release
- Getting started: Introduction, Authentication, Base URL, Headers, Error codes.
- Core modules from the Postman collection: Auth, Platform client APIs, Dashboard, Analytics, User, Custom Roles, Conversation, Messages, Uploads.
- Baseline Reference stubs for samples, status codes, appendix, and changelog.
How we version docs
- Major (x.0) — large restructure or breaking documentation of API contracts.
- Minor (1.x) — new modules or significant endpoint coverage.
- Patch-level wording fixes may ship without a changelog bump when behavior is unchanged.
- API
apiVersion(v1/v2) is independent of this docs version number.