Matrix is a set of APIs for open-federated Instant Messaging (IM), Voice
over IP (VoIP) and Internet of Things (IoT) communication, designed to create
and support a new global real-time communication ecosystem.
There is an `introduction and overview to the specification here <intro.html>`_.
For a more complete introduction to Matrix, see `Introduction <intro.html>`_.
Matrix APIs
-----------
The following APIs are documented in this specification:
- `Client-Server API <client_server.html>`_version %CLIENT_RELEASE_LABEL% for writing Matrix clients.
- `Server-Server API <server_server.html>`_version %SERVER_RELEASE_LABEL% for writing servers which can federate with Matrix.
- `Application Service API <application_service.html>`_version %CLIENT_RELEASE_LABEL% for writing privileged plugins to servers.
- `Identity Service API <identity_service.html>`_version unstable for mapping third party identifiers (e.g. email addresses) to Matrix IDs.
- `Push Gateway API <push_gateway.html>`_version unstable for implementing a server that receives notifications about Matrix events a user is interested in.
- `Client-Server API <client_server.html>`_(%CLIENT_RELEASE_LABEL%) Interaction between clients and servers
- `Server-Server API <server_server.html>`_(%SERVER_RELEASE_LABEL%) Federation between servers
- `Application Service API <application_service.html>`_(%CLIENT_RELEASE_LABEL%) Privileged server plugins
- `Identity Service API <identity_service.html>`_(unstable) Mapping of third party IDs with Matrix IDs
- `Push Gateway API <push_gateway.html>`_(unstable) Push notifications for Matrix events
There are also some `appendices <appendices.html>`_.
`Appendices <appendices.html>`_ with supplemental information not specific to
of the above APIs is also available.
Any developments since the latest release can be found `here`__.
Specification Version
---------------------
..__: https://matrix.org/speculator/spec/head/
The documents in the specification are generated from
`matrix-doc <https://github.com/matrix-org/matrix-doc>`_ as of Git commit